~ubuntu-branches/ubuntu/quantal/evolution-data-server/quantal-proposed : revision 185

49

#include <libedataserver/libedataserver.h>

50

51

struct <a class="link" href="ESourceRegistry.html#ESourceRegistry-struct" title="struct ESourceRegistry">ESourceRegistry</a>;

52

<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-new-sync" title="e_source_registry_new_sync ()">e_source_registry_new_sync</a> (<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

53

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

54

void <a class="link" href="ESourceRegistry.html#e-source-registry-new" title="e_source_registry_new ()">e_source_registry_new</a> (<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

55

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

56

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);

57

<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-new-finish" title="e_source_registry_new_finish ()">e_source_registry_new_finish</a> (<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

58

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

59

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="ESourceRegistry.html#e-source-registry-authenticate-sync" title="e_source_registry_authenticate_sync ()">e_source_registry_authenticate_sync</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

52

<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-new-sync" title="e_source_registry_new_sync ()">e_source_registry_new_sync</a> (<code>GCancellable *cancellable</code>,

53

<code>GError **error</code>);

54

void <a class="link" href="ESourceRegistry.html#e-source-registry-new" title="e_source_registry_new ()">e_source_registry_new</a> (<code>GCancellable *cancellable</code>,

55

<code>GAsyncReadyCallback callback</code>,

56

<code>gpointer user_data</code>);

57

<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-new-finish" title="e_source_registry_new_finish ()">e_source_registry_new_finish</a> (<code>GAsyncResult *result</code>,

58

<code>GError **error</code>);

59

gboolean <a class="link" href="ESourceRegistry.html#e-source-registry-authenticate-sync" title="e_source_registry_authenticate_sync ()">e_source_registry_authenticate_sync</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

60

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

61

<code><a class="link" href="ESourceAuthenticator.html" title="ESourceAuthenticator">ESourceAuthenticator</a> *auth</code>,

62

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

63

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

62

<code>GCancellable *cancellable</code>,

63

<code>GError **error</code>);

64

void <a class="link" href="ESourceRegistry.html#e-source-registry-authenticate" title="e_source_registry_authenticate ()">e_source_registry_authenticate</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

65

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

66

<code><a class="link" href="ESourceAuthenticator.html" title="ESourceAuthenticator">ESourceAuthenticator</a> *auth</code>,

67

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

68

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

69

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);

70

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="ESourceRegistry.html#e-source-registry-authenticate-finish" title="e_source_registry_authenticate_finish ()">e_source_registry_authenticate_finish</a>

67

<code>GCancellable *cancellable</code>,

68

<code>GAsyncReadyCallback callback</code>,

69

<code>gpointer user_data</code>);

70

gboolean <a class="link" href="ESourceRegistry.html#e-source-registry-authenticate-finish" title="e_source_registry_authenticate_finish ()">e_source_registry_authenticate_finish</a>

71

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

72

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

73

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

74

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="ESourceRegistry.html#e-source-registry-commit-source-sync" title="e_source_registry_commit_source_sync ()">e_source_registry_commit_source_sync</a>

72

<code>GAsyncResult *result</code>,

73

<code>GError **error</code>);

74

gboolean <a class="link" href="ESourceRegistry.html#e-source-registry-commit-source-sync" title="e_source_registry_commit_source_sync ()">e_source_registry_commit_source_sync</a>

75

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

76

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

77

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

78

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

77

<code>GCancellable *cancellable</code>,

78

<code>GError **error</code>);

79

void <a class="link" href="ESourceRegistry.html#e-source-registry-commit-source" title="e_source_registry_commit_source ()">e_source_registry_commit_source</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

80

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

81

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

82

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

83

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);

84

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="ESourceRegistry.html#e-source-registry-commit-source-finish" title="e_source_registry_commit_source_finish ()">e_source_registry_commit_source_finish</a>

85

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

86

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

87

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

88

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="ESourceRegistry.html#e-source-registry-create-sources-sync" title="e_source_registry_create_sources_sync ()">e_source_registry_create_sources_sync</a>

89

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

90

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> *list_of_sources</code>,

91

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

92

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

81

<code>GCancellable *cancellable</code>,

82

<code>GAsyncReadyCallback callback</code>,

83

<code>gpointer user_data</code>);

84

gboolean <a class="link" href="ESourceRegistry.html#e-source-registry-commit-source-finish" title="e_source_registry_commit_source_finish ()">e_source_registry_commit_source_finish</a>

85

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

86

<code>GAsyncResult *result</code>,

87

<code>GError **error</code>);

88

gboolean <a class="link" href="ESourceRegistry.html#e-source-registry-create-sources-sync" title="e_source_registry_create_sources_sync ()">e_source_registry_create_sources_sync</a>

89

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

90

<code>GList *list_of_sources</code>,

91

<code>GCancellable *cancellable</code>,

92

<code>GError **error</code>);

93

void <a class="link" href="ESourceRegistry.html#e-source-registry-create-sources" title="e_source_registry_create_sources ()">e_source_registry_create_sources</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

94

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> *list_of_sources</code>,

95

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

96

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

97

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);

98

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="ESourceRegistry.html#e-source-registry-create-sources-finish" title="e_source_registry_create_sources_finish ()">e_source_registry_create_sources_finish</a>

94

<code>GList *list_of_sources</code>,

95

<code>GCancellable *cancellable</code>,

96

<code>GAsyncReadyCallback callback</code>,

97

<code>gpointer user_data</code>);

98

gboolean <a class="link" href="ESourceRegistry.html#e-source-registry-create-sources-finish" title="e_source_registry_create_sources_finish ()">e_source_registry_create_sources_finish</a>

99

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

100

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

101

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);

100

<code>GAsyncResult *result</code>,

101

<code>GError **error</code>);

102

<a class="link" href="ESource.html" title="ESource">ESource</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-ref-source" title="e_source_registry_ref_source ()">e_source_registry_ref_source</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

103

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *uid</code>);

104

<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-list-sources" title="e_source_registry_list_sources ()">e_source_registry_list_sources</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

105

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);

103

<code>const gchar *uid</code>);

104

GList * <a class="link" href="ESourceRegistry.html#e-source-registry-list-sources" title="e_source_registry_list_sources ()">e_source_registry_list_sources</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

105

<code>const gchar *extension_name</code>);

106

<a class="link" href="ESource.html" title="ESource">ESource</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-find-extension" title="e_source_registry_find_extension ()">e_source_registry_find_extension</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

107

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

108

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);

109

<a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-build-display-tree" title="e_source_registry_build_display_tree ()">e_source_registry_build_display_tree</a>

108

<code>const gchar *extension_name</code>);

109

GNode * <a class="link" href="ESourceRegistry.html#e-source-registry-build-display-tree" title="e_source_registry_build_display_tree ()">e_source_registry_build_display_tree</a>

110

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

111

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);

112

void <a class="link" href="ESourceRegistry.html#e-source-registry-free-display-tree" title="e_source_registry_free_display_tree ()">e_source_registry_free_display_tree</a> (<code><a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> *display_tree</code>);

111

<code>const gchar *extension_name</code>);

112

void <a class="link" href="ESourceRegistry.html#e-source-registry-free-display-tree" title="e_source_registry_free_display_tree ()">e_source_registry_free_display_tree</a> (<code>GNode *display_tree</code>);

113

void <a class="link" href="ESourceRegistry.html#e-source-registry-debug-dump" title="e_source_registry_debug_dump ()">e_source_registry_debug_dump</a> (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

114

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);

114

<code>const gchar *extension_name</code>);

115

<a class="link" href="ESource.html" title="ESource">ESource</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-ref-builtin-address-book" title="e_source_registry_ref_builtin_address_book ()">e_source_registry_ref_builtin_address_book</a>

116

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>);

117

<a class="link" href="ESource.html" title="ESource">ESource</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-ref-default-address-book" title="e_source_registry_ref_default_address_book ()">e_source_registry_ref_default_address_book</a>

154

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);

155

<a class="link" href="ESource.html" title="ESource">ESource</a> * <a class="link" href="ESourceRegistry.html#e-source-registry-ref-default-for-extension-name" title="e_source_registry_ref_default_for_extension_name ()">e_source_registry_ref_default_for_extension_name</a>

156

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

157

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);

157

<code>const gchar *extension_name</code>);

158

void <a class="link" href="ESourceRegistry.html#e-source-registry-set-default-for-extension-name" title="e_source_registry_set_default_for_extension_name ()">e_source_registry_set_default_for_extension_name</a>

159

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

160

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>,

160

<code>const gchar *extension_name</code>,

161

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);

162

</pre>

163

</div>

164

165

<a name="ESourceRegistry.object-hierarchy"></a><h2>Object Hierarchy</h2>

166

167

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

167

GObject

168

+----ESourceRegistry

169

</pre>

170

</div>

172

<a name="ESourceRegistry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>

173

174

ESourceRegistry implements

175

<a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.

175

GInitable and GAsyncInitable.

176

</div>

177

178

<a name="ESourceRegistry.properties"></a><h2>Properties</h2>

188

189

<a name="ESourceRegistry.signals"></a><h2>Signals</h2>

190

191

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-added" title='The "source-added" signal'>source-added</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

192

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-changed" title='The "source-changed" signal'>source-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

193

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-disabled" title='The "source-disabled" signal'>source-disabled</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

194

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-enabled" title='The "source-enabled" signal'>source-enabled</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

195

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-removed" title='The "source-removed" signal'>source-removed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

191

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-added" title='The "source-added" signal'>source-added</a>" : <code class="literal">Run Last</code>

192

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-changed" title='The "source-changed" signal'>source-changed</a>" : <code class="literal">Run Last</code>

193

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-disabled" title='The "source-disabled" signal'>source-disabled</a>" : <code class="literal">Run Last</code>

194

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-enabled" title='The "source-enabled" signal'>source-enabled</a>" : <code class="literal">Run Last</code>

195

"<a class="link" href="ESourceRegistry.html#ESourceRegistry-source-removed" title='The "source-removed" signal'>source-removed</a>" : <code class="literal">Run Last</code>

196

</pre>

197

</div>

198

212

213

214

The <a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> API also provides a front-end for the

215

"org.gnome.Evolution.DefaultSources" <a href="http://library.gnome.org/devel/gio/unstable/GSettings.html">GSettings</a> schema which tracks

215

"org.gnome.Evolution.DefaultSources" GSettings schema which tracks

216

which <a class="link" href="ESource.html" title="ESource">ESource</a> instances are designated to be the user's default address

217

book, calendar, memo list and task list for desktop integration.

218

231

<hr>

232

233

<a name="e-source-registry-new-sync"></a><h3>e_source_registry_new_sync ()</h3>

234

<pre class="programlisting"><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * e_source_registry_new_sync (<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

235

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

234

<pre class="programlisting"><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * e_source_registry_new_sync (<code>GCancellable *cancellable</code>,

235

<code>GError **error</code>);</pre>

236

237

Creates a new <a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> front-end for the registry D-Bus service.

238

If an error occurs in connecting to the D-Bus service, the function sets

239

<code>error</code> and returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

239

<code>error</code> and returns <code class="literal">NULL</code>.

240

241

242

243

<tbody>

244

<tr>

245

<td><code>cancellable</code> :</td>

246

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

246

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

247

</td>

248

</tr>

249

<tr>

250

<td><code>error</code> :</td>

251

<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

251

<td>return location for a GError, or <code class="literal">NULL</code>

252

</td>

253

</tr>

254

<tr>

255

<td>Returns :</td>

256

<td>a new <a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

256

<td>a new <a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a>, or <code class="literal">NULL</code>

257

</td>

258

</tr>

259

</tbody>

263

<hr>

264

265

<a name="e-source-registry-new"></a><h3>e_source_registry_new ()</h3>

266

<pre class="programlisting">void e_source_registry_new (<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

267

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

268

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

266

<pre class="programlisting">void e_source_registry_new (<code>GCancellable *cancellable</code>,

267

<code>GAsyncReadyCallback callback</code>,

268

<code>gpointer user_data</code>);</pre>

269

270

Asynchronously creates a new <a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> front-end for the registry

271

D-Bus service.

279

<tbody>

280

<tr>

281

<td><code>cancellable</code> :</td>

282

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

282

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

283

</td>

284

</tr>

285

<tr>

286

<td><code>callback</code> :</td>

287

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> to call when the request

287

<td>a GAsyncReadyCallback to call when the request

288

is satisfied. [<acronym title="The callback is valid until first called.">scope async</acronym>]

289

</td>

290

</tr>

300

<hr>

301

302

<a name="e-source-registry-new-finish"></a><h3>e_source_registry_new_finish ()</h3>

303

<pre class="programlisting"><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * e_source_registry_new_finish (<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

304

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

303

<pre class="programlisting"><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> * e_source_registry_new_finish (<code>GAsyncResult *result</code>,

304

<code>GError **error</code>);</pre>

305

306

Finishes the operation started with <a class="link" href="ESourceRegistry.html#e-source-registry-new-finish" title="e_source_registry_new_finish ()"><code class="function">e_source_registry_new_finish()</code></a>.

307

If an error occurs in connecting to the D-Bus service, the function

308

sets <code>error</code> and returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

308

sets <code>error</code> and returns <code class="literal">NULL</code>.

309

310

311

312

<tbody>

313

<tr>

314

<td><code>result</code> :</td>

315

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a>

315

<td>a GAsyncResult

316

</td>

317

</tr>

318

<tr>

319

<td><code>error</code> :</td>

320

<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

320

<td>return location for a GError, or <code class="literal">NULL</code>

321

</td>

322

</tr>

323

<tr>

324

<td>Returns :</td>

325

<td>a new <a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

325

<td>a new <a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a>, or <code class="literal">NULL</code>

326

</td>

327

</tr>

328

</tbody>

332

<hr>

333

334

<a name="e-source-registry-authenticate-sync"></a><h3>e_source_registry_authenticate_sync ()</h3>

335

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> e_source_registry_authenticate_sync (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

335

<pre class="programlisting">gboolean e_source_registry_authenticate_sync (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

336

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

337

<code><a class="link" href="ESourceAuthenticator.html" title="ESourceAuthenticator">ESourceAuthenticator</a> *auth</code>,

338

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

339

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

338

<code>GCancellable *cancellable</code>,

339

<code>GError **error</code>);</pre>

340

341

Authenticates <code>source</code>, using <code>auth</code> to handle the authentication

342

attempts. The operation loops until authentication is successful or

343

the user aborts further authentication attempts. If an error occurs,

344

the function will set <code>error</code> and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

344

the function will set <code>error</code> and return <code class="literal">FALSE</code>.

345

346

347

Note that <code>source</code> need not have a <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a>, which means this

347

Note that <code>source</code> need not have a GDBusObject, which means this

348

function can test authentication on a scratch <a class="link" href="ESource.html" title="ESource">ESource</a>.

349

350

372

</tr>

373

<tr>

374

<td><code>cancellable</code> :</td>

375

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

375

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

376

</td>

377

</tr>

378

<tr>

379

<td><code>error</code> :</td>

380

<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

380

<td>return location for a GError, or <code class="literal">NULL</code>

381

</td>

382

</tr>

383

<tr>

384

<td>Returns :</td>

385

<td>

386

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>

386

<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>

387

</tr>

388

</tbody>

389

</table></div>

395

<pre class="programlisting">void e_source_registry_authenticate (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

396

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

397

<code><a class="link" href="ESourceAuthenticator.html" title="ESourceAuthenticator">ESourceAuthenticator</a> *auth</code>,

398

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

399

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

400

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

398

<code>GCancellable *cancellable</code>,

399

<code>GAsyncReadyCallback callback</code>,

400

<code>gpointer user_data</code>);</pre>

401

402

Asynchronously authenticates <code>source</code>, using <code>auth</code> to handle the

403

authentication attempts. The operation loops until authentication

404

is successful or the user aborts further authentication attempts.

405

406

407

Note that <code>source</code> need not have a <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a>, which means this

407

Note that <code>source</code> need not have a GDBusObject, which means this

408

function can test authentication on a scratch <a class="link" href="ESource.html" title="ESource">ESource</a>.

409

410

437

</tr>

438

<tr>

439

<td><code>cancellable</code> :</td>

440

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

440

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

441

</td>

442

</tr>

443

<tr>

444

<td><code>callback</code> :</td>

445

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> to call when the request

445

<td>a GAsyncReadyCallback to call when the request

446

is satisfied. [<acronym title="The callback is valid until first called.">scope async</acronym>]

447

</td>

448

</tr>

458

<hr>

459

460

<a name="e-source-registry-authenticate-finish"></a><h3>e_source_registry_authenticate_finish ()</h3>

461

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> e_source_registry_authenticate_finish

461

<pre class="programlisting">gboolean e_source_registry_authenticate_finish

462

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

463

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

464

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

463

<code>GAsyncResult *result</code>,

464

<code>GError **error</code>);</pre>

465

466

Finishes the operation started with <a class="link" href="ESourceRegistry.html#e-source-registry-authenticate" title="e_source_registry_authenticate ()"><code class="function">e_source_registry_authenticate()</code></a>.

467

If an error occurred, the function will set <code>error</code> and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

467

If an error occurred, the function will set <code>error</code> and return <code class="literal">FALSE</code>.

468

469

470

476

</tr>

477

<tr>

478

<td><code>result</code> :</td>

479

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a>

479

<td>a GAsyncResult

480

</td>

481

</tr>

482

<tr>

483

<td><code>error</code> :</td>

484

<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

484

<td>return location for a GError, or <code class="literal">NULL</code>

485

</td>

486

</tr>

487

<tr>

488

<td>Returns :</td>

489

<td>

490

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>

490

<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>

491

</tr>

492

</tbody>

493

</table></div>

496

<hr>

497

498

<a name="e-source-registry-commit-source-sync"></a><h3>e_source_registry_commit_source_sync ()</h3>

499

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> e_source_registry_commit_source_sync

499

<pre class="programlisting">gboolean e_source_registry_commit_source_sync

500

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

501

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

502

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

503

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

502

<code>GCancellable *cancellable</code>,

503

<code>GError **error</code>);</pre>

504

505

This is a convenience function intended for use with graphical

506

<a class="link" href="ESource.html" title="ESource">ESource</a> editors. Call this function when the user is finished

507

making changes to <code>source</code>.

508

509

510

If <code>source</code> has a <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a>, its contents are submitted to the D-Bus

510

If <code>source</code> has a GDBusObject, its contents are submitted to the D-Bus

511

service through <a class="link" href="ESource.html#e-source-write-sync" title="e_source_write_sync ()"><code class="function">e_source_write_sync()</code></a>.

512

513

514

If <code>source</code> does NOT have a <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a> (implying it's a scratch

514

If <code>source</code> does NOT have a GDBusObject (implying it's a scratch

515

<a class="link" href="ESource.html" title="ESource">ESource</a>), its contents are submitted to the D-Bus service through

516

either <a class="link" href="ESource.html#e-source-remote-create-sync" title="e_source_remote_create_sync ()"><code class="function">e_source_remote_create_sync()</code></a> if <code>source</code> is to be a collection

517

member, or <a class="link" href="ESourceRegistry.html#e-source-registry-create-sources-sync" title="e_source_registry_create_sources_sync ()"><code class="function">e_source_registry_create_sources_sync()</code></a> if <code>source</code> to be an

518

independent data source.

519

520

521

If an error occurs, the function will set <code>error</code> and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

521

If an error occurs, the function will set <code>error</code> and return <code class="literal">FALSE</code>.

522

523

524

534

</tr>

535

<tr>

536

<td><code>cancellable</code> :</td>

537

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

537

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

538

</td>

539

</tr>

540

<tr>

541

<td><code>error</code> :</td>

542

<td>return location for <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

542

<td>return location for GError, or <code class="literal">NULL</code>

543

</td>

544

</tr>

545

<tr>

546

<td>Returns :</td>

547

<td>

548

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>

548

<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>

549

</tr>

550

</tbody>

551

</table></div>

556

<a name="e-source-registry-commit-source"></a><h3>e_source_registry_commit_source ()</h3>

557

<pre class="programlisting">void e_source_registry_commit_source (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

558

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

559

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

560

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

561

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

559

<code>GCancellable *cancellable</code>,

560

<code>GAsyncReadyCallback callback</code>,

561

<code>gpointer user_data</code>);</pre>

562

563

See <a class="link" href="ESourceRegistry.html#e-source-registry-commit-source-sync" title="e_source_registry_commit_source_sync ()"><code class="function">e_source_registry_commit_source_sync()</code></a> for details.

564

581

</tr>

582

<tr>

583

<td><code>cancellable</code> :</td>

584

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

584

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

585

</td>

586

</tr>

587

<tr>

588

<td><code>callback</code> :</td>

589

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> to call when the request

589

<td>a GAsyncReadyCallback to call when the request

590

is satisfied. [<acronym title="The callback is valid until first called.">scope async</acronym>]

591

</td>

592

</tr>

602

<hr>

603

604

<a name="e-source-registry-commit-source-finish"></a><h3>e_source_registry_commit_source_finish ()</h3>

605

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> e_source_registry_commit_source_finish

605

<pre class="programlisting">gboolean e_source_registry_commit_source_finish

606

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

607

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

608

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

607

<code>GAsyncResult *result</code>,

608

<code>GError **error</code>);</pre>

609

610

Finishes the operation started with <a class="link" href="ESourceRegistry.html#e-source-registry-commit-source" title="e_source_registry_commit_source ()"><code class="function">e_source_registry_commit_source()</code></a>.

611

612

613

If an error occurred, the function will set <code>error</code> and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

613

If an error occurred, the function will set <code>error</code> and return <code class="literal">FALSE</code>.

614

615

616

622

</tr>

623

<tr>

624

<td><code>result</code> :</td>

625

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a>

625

<td>a GAsyncResult

626

</td>

627

</tr>

628

<tr>

629

<td><code>error</code> :</td>

630

<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

630

<td>return location for a GError, or <code class="literal">NULL</code>

631

</td>

632

</tr>

633

<tr>

634

<td>Returns :</td>

635

<td>

636

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>

636

<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>

637

</tr>

638

</tbody>

639

</table></div>

642

<hr>

643

644

<a name="e-source-registry-create-sources-sync"></a><h3>e_source_registry_create_sources_sync ()</h3>

645

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> e_source_registry_create_sources_sync

645

<pre class="programlisting">gboolean e_source_registry_create_sources_sync

646

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

647

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> *list_of_sources</code>,

648

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

649

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

647

<code>GList *list_of_sources</code>,

648

<code>GCancellable *cancellable</code>,

649

<code>GError **error</code>);</pre>

650

651

Requests the D-Bus service create new key files for each <a class="link" href="ESource.html" title="ESource">ESource</a> in

652

<code>list_of_sources</code>. Each list element must be a scratch <a class="link" href="ESource.html" title="ESource">ESource</a> with

653

no <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a>.

653

no GDBusObject.

654

655

656

If an error occurs, the function will set <code>error</code> and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

656

If an error occurs, the function will set <code>error</code> and return <code class="literal">FALSE</code>.

657

658

659

666

<tr>

667

<td><code>list_of_sources</code> :</td>

668

<td>a list of <a class="link" href="ESource.html" title="ESource">ESource</a> instances with

669

no <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a>. [<acronym title="Generics and defining elements of containers and arrays.">element-type</acronym> ESource]

669

no GDBusObject. [<acronym title="Generics and defining elements of containers and arrays.">element-type</acronym> ESource]

670

</td>

671

</tr>

672

<tr>

673

<td><code>cancellable</code> :</td>

674

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

674

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

675

</td>

676

</tr>

677

<tr>

678

<td><code>error</code> :</td>

679

<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

679

<td>return location for a GError, or <code class="literal">NULL</code>

680

</td>

681

</tr>

682

<tr>

683

<td>Returns :</td>

684

<td>

685

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>

685

<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>

686

</tr>

687

</tbody>

688

</table></div>

692

693

<a name="e-source-registry-create-sources"></a><h3>e_source_registry_create_sources ()</h3>

694

<pre class="programlisting">void e_source_registry_create_sources (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

695

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> *list_of_sources</code>,

696

<code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> *cancellable</code>,

697

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> callback</code>,

698

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

695

<code>GList *list_of_sources</code>,

696

<code>GCancellable *cancellable</code>,

697

<code>GAsyncReadyCallback callback</code>,

698

<code>gpointer user_data</code>);</pre>

699

700

Asynchronously requests the D-Bus service create new key files for each

701

<a class="link" href="ESource.html" title="ESource">ESource</a> in <code>list_of_sources</code>. Each list element must be a scratch

702

<a class="link" href="ESource.html" title="ESource">ESource</a> with no <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a>.

702

<a class="link" href="ESource.html" title="ESource">ESource</a> with no GDBusObject.

703

704

705

When the operation is finished, <code>callback</code> will be called. You can then

717

<tr>

718

<td><code>list_of_sources</code> :</td>

719

<td>a list of <a class="link" href="ESource.html" title="ESource">ESource</a> instances with

720

no <a href="http://library.gnome.org/devel/gio/unstable/GDBusObject.html">GDBusObject</a>. [<acronym title="Generics and defining elements of containers and arrays.">element-type</acronym> ESource]

720

no GDBusObject. [<acronym title="Generics and defining elements of containers and arrays.">element-type</acronym> ESource]

721

</td>

722

</tr>

723

<tr>

724

<td><code>cancellable</code> :</td>

725

<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html">GCancellable</a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

725

<td>optional GCancellable object, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

726

</td>

727

</tr>

728

<tr>

729

<td><code>callback</code> :</td>

730

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback">GAsyncReadyCallback</a> to call when the request

730

<td>a GAsyncReadyCallback to call when the request

731

is satisfied. [<acronym title="The callback is valid until first called.">scope async</acronym>]

732

</td>

733

</tr>

743

<hr>

744

745

<a name="e-source-registry-create-sources-finish"></a><h3>e_source_registry_create_sources_finish ()</h3>

746

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> e_source_registry_create_sources_finish

746

<pre class="programlisting">gboolean e_source_registry_create_sources_finish

747

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

748

<code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a> *result</code>,

749

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

748

<code>GAsyncResult *result</code>,

749

<code>GError **error</code>);</pre>

750

751

Finishes the operation started with <a class="link" href="ESourceRegistry.html#e-source-registry-create-sources" title="e_source_registry_create_sources ()"><code class="function">e_source_registry_create_sources()</code></a>.

752

753

754

If an error occurred, the function will set <code>error</code> and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

754

If an error occurred, the function will set <code>error</code> and return <code class="literal">FALSE</code>.

755

756

757

763

</tr>

764

<tr>

765

<td><code>result</code> :</td>

766

<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html">GAsyncResult</a>

766

<td>a GAsyncResult

767

</td>

768

</tr>

769

<tr>

770

<td><code>error</code> :</td>

771

<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

771

<td>return location for a GError, or <code class="literal">NULL</code>

772

</td>

773

</tr>

774

<tr>

775

<td>Returns :</td>

776

<td>

777

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>

777

<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>

778

</tr>

779

</tbody>

780

</table></div>

784

785

<a name="e-source-registry-ref-source"></a><h3>e_source_registry_ref_source ()</h3>

786

<pre class="programlisting"><a class="link" href="ESource.html" title="ESource">ESource</a> * e_source_registry_ref_source (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

787

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *uid</code>);</pre>

787

<code>const gchar *uid</code>);</pre>

788

789

Looks up an <a class="link" href="ESource.html" title="ESource">ESource</a> in <code>registry</code> by its unique identifier string.

790

791

792

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

793

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

793

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

794

795

796

806

</tr>

807

<tr>

808

<td>Returns :</td>

809

<td>an <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found. [<acronym title="Free data after the code is done.">transfer full</acronym>]

809

<td>an <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code> if no match was found. [<acronym title="Free data after the code is done.">transfer full</acronym>]

810

</td>

811

</tr>

812

</tbody>

816

<hr>

817

818

<a name="e-source-registry-list-sources"></a><h3>e_source_registry_list_sources ()</h3>

819

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList">GList</a> * e_source_registry_list_sources (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

820

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);</pre>

819

<pre class="programlisting">GList * e_source_registry_list_sources (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

820

<code>const gchar *extension_name</code>);</pre>

821

822

Returns a list of registered sources, sorted by display name. If

823

<code>extension_name</code> is given, restrict the list to sources having that

825

826

827

The sources returned in the list are referenced for thread-safety.

828

They must each be unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished

829

when them. Free the returned list itself with <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.

828

They must each be unreferenced with <code class="function">g_object_unref()</code> when finished

829

when them. Free the returned list itself with <code class="function">g_list_free()</code>.

830

831

832

An easy way to free the list properly in one step is as follows:

838

<tbody>

839

<tr>

840

841

<td class="listing_code"><pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free-full">g_list_free_full</a> (list, g_object_unref);</pre></td>

841

<td class="listing_code"><pre class="programlisting">g_list_free_full (list, g_object_unref);</pre></td>

842

</tr>

843

</tbody>

844

</table>

856

</tr>

857

<tr>

858

<td><code>extension_name</code> :</td>

859

<td>an extension name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

859

<td>an extension name, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

860

</td>

861

</tr>

862

<tr>

873

<a name="e-source-registry-find-extension"></a><h3>e_source_registry_find_extension ()</h3>

874

<pre class="programlisting"><a class="link" href="ESource.html" title="ESource">ESource</a> * e_source_registry_find_extension (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

875

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *source</code>,

876

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);</pre>

876

<code>const gchar *extension_name</code>);</pre>

877

878

Examines <code>source</code> and its ancestors and returns the "deepest" <a class="link" href="ESource.html" title="ESource">ESource</a>

879

having an <a class="link" href="ESourceExtension.html" title="ESourceExtension">ESourceExtension</a> with the given <code>extension_name</code>. If neither

880

<code>source</code> nor any of its ancestors have such an extension, the function

881

returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

881

returns <code class="literal">NULL</code>.

882

883

884

This function is useful in cases when an <a class="link" href="ESourceExtension.html" title="ESourceExtension">ESourceExtension</a> is meant to

892

893

894

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

895

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

895

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

896

897

898

Note the function returns the <a class="link" href="ESource.html" title="ESource">ESource</a> containing the <a class="link" href="ESourceExtension.html" title="ESourceExtension">ESourceExtension</a>

918

</tr>

919

<tr>

920

<td>Returns :</td>

921

<td>an <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found. [<acronym title="Free data after the code is done.">transfer full</acronym>]

921

<td>an <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code> if no match was found. [<acronym title="Free data after the code is done.">transfer full</acronym>]

922

</td>

923

</tr>

924

</tbody>

928

<hr>

929

930

<a name="e-source-registry-build-display-tree"></a><h3>e_source_registry_build_display_tree ()</h3>

931

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> * e_source_registry_build_display_tree

931

<pre class="programlisting">GNode * e_source_registry_build_display_tree

932

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

933

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);</pre>

933

<code>const gchar *extension_name</code>);</pre>

934

935

Returns a single <a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> tree of registered sources that can be used to

936

populate a <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html">GtkTreeModel</a>. (The root <a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> is just an empty placeholder.)

935

Returns a single GNode tree of registered sources that can be used to

936

populate a GtkTreeModel. (The root GNode is just an empty placeholder.)

937

938

939

Similar to <a class="link" href="ESourceRegistry.html#e-source-registry-list-sources" title="e_source_registry_list_sources ()"><code class="function">e_source_registry_list_sources()</code></a>, an <code>extension_name</code> can be

942

an extension named <code>extension_name</code>.

943

944

945

Disabled leaf nodes are automatically excluded from the <a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> tree.

945

Disabled leaf nodes are automatically excluded from the GNode tree.

946

947

948

The sources returned in the tree are referenced for thread-safety.

949

They must each be unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished

950

with them. Free the returned tree itself with <a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#g-node-destroy"><code class="function">g_node_destroy()</code></a>.

949

They must each be unreferenced with <code class="function">g_object_unref()</code> when finished

950

with them. Free the returned tree itself with <code class="function">g_node_destroy()</code>.

951

For convenience, <a class="link" href="ESourceRegistry.html#e-source-registry-free-display-tree" title="e_source_registry_free_display_tree ()"><code class="function">e_source_registry_free_display_tree()</code></a> does all

952

that in one step.

953

961

</tr>

962

<tr>

963

<td><code>extension_name</code> :</td>

964

<td>an extension name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

964

<td>an extension name, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

965

</td>

966

</tr>

967

<tr>

977

<hr>

978

979

<a name="e-source-registry-free-display-tree"></a><h3>e_source_registry_free_display_tree ()</h3>

980

<pre class="programlisting">void e_source_registry_free_display_tree (<code><a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> *display_tree</code>);</pre>

980

<pre class="programlisting">void e_source_registry_free_display_tree (<code>GNode *display_tree</code>);</pre>

981

982

Convenience function to free a <a href="http://library.gnome.org/devel/glib/unstable/glib-N-ary-Trees.html#GNode">GNode</a> tree of registered

982

Convenience function to free a GNode tree of registered

983

sources created by <a class="link" href="ESourceRegistry.html#e-source-registry-build-display-tree" title="e_source_registry_build_display_tree ()"><code class="function">e_source_registry_build_display_tree()</code></a>.

984

985

995

996

<a name="e-source-registry-debug-dump"></a><h3>e_source_registry_debug_dump ()</h3>

997

<pre class="programlisting">void e_source_registry_debug_dump (<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

998

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);</pre>

998

<code>const gchar *extension_name</code>);</pre>

999

1000

Handy debugging function that uses <a class="link" href="ESourceRegistry.html#e-source-registry-build-display-tree" title="e_source_registry_build_display_tree ()"><code class="function">e_source_registry_build_display_tree()</code></a>

1001

to print a tree of registered sources to standard output.

1010

</tr>

1011

<tr>

1012

<td><code>extension_name</code> :</td>

1013

<td>an extension name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1013

<td>an extension name, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1014

</td>

1015

</tr>

1016

</tbody>

1030

1031

1032

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1033

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1033

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1034

1035

1036

1061

1062

1063

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1064

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1064

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1065

1066

1067

1088

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);</pre>

1089

1090

Sets <code>default_source</code> as the default address book. If <code>default_source</code>

1091

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default address book is reset to the built-in address book.

1091

is <code class="literal">NULL</code>, the default address book is reset to the built-in address book.

1092

This setting will persist across sessions until changed.

1093

1094

1101

</tr>

1102

<tr>

1103

<td><code>default_source</code> :</td>

1104

<td>an address book <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1104

<td>an address book <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1105

</td>

1106

</tr>

1107

</tbody>

1121

1122

1123

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1124

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1124

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1125

1126

1127

1152

1153

1154

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1155

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1155

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1156

1157

1158

1179

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);</pre>

1180

1181

Sets <code>default_source</code> as the default calendar. If <code>default_source</code>

1182

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default calendar is reset to the built-in calendar.

1182

is <code class="literal">NULL</code>, the default calendar is reset to the built-in calendar.

1183

This setting will persist across sessions until changed.

1184

1185

1192

</tr>

1193

<tr>

1194

<td><code>default_source</code> :</td>

1195

<td>a calendar <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1195

<td>a calendar <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1196

</td>

1197

</tr>

1198

</tbody>

1212

1213

1214

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1215

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1215

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1216

1217

1218

1243

1244

1245

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1246

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1246

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1247

1248

1249

1270

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);</pre>

1271

1272

Sets <code>default_source</code> as the default mail account. If <code>default_source</code>

1273

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default mail account is reset to the built-in mail account.

1273

is <code class="literal">NULL</code>, the default mail account is reset to the built-in mail account.

1274

This setting will persist across sessions until changed.

1275

1276

1283

</tr>

1284

<tr>

1285

<td><code>default_source</code> :</td>

1286

<td>a mail account <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1286

<td>a mail account <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1287

</td>

1288

</tr>

1289

</tbody>

1300

<a class="link" href="ESourceRegistry.html#e-source-registry-set-default-mail-identity" title="e_source_registry_set_default_mail_identity ()"><code class="function">e_source_registry_set_default_mail_identity()</code></a> either in this session

1301

or a previous session, or else falls back to the mail identity named

1302

by the default mail account. If even that fails it returns any mail

1303

identity from <code>registry</code>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there are none.

1303

identity from <code>registry</code>, or <code class="literal">NULL</code> if there are none.

1304

1305

1306

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1307

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1307

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1308

1309

1310

1316

</tr>

1317

<tr>

1318

<td>Returns :</td>

1319

<td>the default mail identity <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="Free data after the code is done.">transfer full</acronym>]

1319

<td>the default mail identity <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="Free data after the code is done.">transfer full</acronym>]

1320

</td>

1321

</tr>

1322

</tbody>

1331

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);</pre>

1332

1333

Sets <code>default_source</code> as the default mail identity. If <code>default_source</code>

1334

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the next request for the default mail identity will use the

1334

is <code class="literal">NULL</code>, the next request for the default mail identity will use the

1335

fallbacks described in <code class="function">e_source_registry_get_default_mail_identity()</code>.

1336

1337

1344

</tr>

1345

<tr>

1346

<td><code>default_source</code> :</td>

1347

<td>a mail identity <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1347

<td>a mail identity <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1348

</td>

1349

</tr>

1350

</tbody>

1364

1365

1366

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1367

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1367

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1368

1369

1370

1395

1396

1397

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1398

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1398

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1399

1400

1401

1422

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);</pre>

1423

1424

Sets <code>default_source</code> as the default memo list. If <code>default_source</code>

1425

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default memo list is reset to the built-in memo list.

1425

is <code class="literal">NULL</code>, the default memo list is reset to the built-in memo list.

1426

This setting will persist across sessions until changed.

1427

1428

1435

</tr>

1436

<tr>

1437

<td><code>default_source</code> :</td>

1438

<td>a memo list <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1438

<td>a memo list <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1439

</td>

1440

</tr>

1441

</tbody>

1455

1456

1457

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1458

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1458

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1459

1460

1461

1486

1487

1488

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1489

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1489

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1490

1491

1492

1513

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);</pre>

1514

1515

Sets <code>default_source</code> as the default task list. If <code>default_source</code>

1516

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default task list is reset to the built-in task list.

1516

is <code class="literal">NULL</code>, the default task list is reset to the built-in task list.

1517

This setting will persist across sessions until changed.

1518

1519

1526

</tr>

1527

<tr>

1528

<td><code>default_source</code> :</td>

1529

<td>a task list <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1529

<td>a task list <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1530

</td>

1531

</tr>

1532

</tbody>

1538

<a name="e-source-registry-ref-default-for-extension-name"></a><h3>e_source_registry_ref_default_for_extension_name ()</h3>

1539

<pre class="programlisting"><a class="link" href="ESource.html" title="ESource">ESource</a> * e_source_registry_ref_default_for_extension_name

1540

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

1541

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>);</pre>

1541

<code>const gchar *extension_name</code>);</pre>

1542

1543

This is a convenience function to return a default <a class="link" href="ESource.html" title="ESource">ESource</a> based on

1544

<code>extension_name</code>. This only works with a subset of extension names.

1571

the current default task list, or else falls back to the built-in task list.

1572

1573

1574

For all other values of <code>extension_name</code>, the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

1574

For all other values of <code>extension_name</code>, the function returns <code class="literal">NULL</code>.

1575

1576

1577

The returned <a class="link" href="ESource.html" title="ESource">ESource</a> is referenced for thread-safety and must be

1578

unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.

1578

unreferenced with <code class="function">g_object_unref()</code> when finished with it.

1579

1580

1581

1603

<a name="e-source-registry-set-default-for-extension-name"></a><h3>e_source_registry_set_default_for_extension_name ()</h3>

1604

<pre class="programlisting">void e_source_registry_set_default_for_extension_name

1605

(<code><a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry</code>,

1606

<code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *extension_name</code>,

1606

<code>const gchar *extension_name</code>,

1607

<code><a class="link" href="ESource.html" title="ESource">ESource</a> *default_source</code>);</pre>

1608

1609

This is a convenience function to set a default <a class="link" href="ESource.html" title="ESource">ESource</a> based on

1612

1613

If <code>extension_name</code> is <a class="link" href="ESourceAddressBook.html#E-SOURCE-EXTENSION-ADDRESS-BOOK:CAPS" title="E_SOURCE_EXTENSION_ADDRESS_BOOK">E_SOURCE_EXTENSION_ADDRESS_BOOK</a>, the function

1614

sets <code>default_source</code> as the default address book. If <code>default_source</code>

1615

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default address book is reset to the built-in address book.

1615

is <code class="literal">NULL</code>, the default address book is reset to the built-in address book.

1616

1617

1618

If <code>extension_name</code> is <a class="link" href="ESourceCalendar.html#E-SOURCE-EXTENSION-CALENDAR:CAPS" title="E_SOURCE_EXTENSION_CALENDAR">E_SOURCE_EXTENSION_CALENDAR</a>, the function sets

1619

<code>default_source</code> as the default calendar. If <code>default_source</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,

1619

<code>default_source</code> as the default calendar. If <code>default_source</code> is <code class="literal">NULL</code>,

1620

the default calendar is reset to the built-in calendar.

1621

1622

1623

If <code>extension_name</code> is <a class="link" href="ESourceMailAccount.html#E-SOURCE-EXTENSION-MAIL-ACCOUNT:CAPS" title="E_SOURCE_EXTENSION_MAIL_ACCOUNT">E_SOURCE_EXTENSION_MAIL_ACCOUNT</a>, the function

1624

sets <code>default_source</code> as the default mail account. If <code>default_source</code>

1625

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the default mail account is reset to the built-in mail account.

1625

is <code class="literal">NULL</code>, the default mail account is reset to the built-in mail account.

1626

1627

1628

If <code>extension_name</code> is <a class="link" href="ESourceMailIdentity.html#E-SOURCE-EXTENSION-MAIL-IDENTITY:CAPS" title="E_SOURCE_EXTENSION_MAIL_IDENTITY">E_SOURCE_EXTENSION_MAIL_IDENTITY</a>, the function

1629

sets <code>default_source</code> as the default mail identity. If <code>default_source</code>

1630

is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the next request for the default mail identity will return

1630

is <code class="literal">NULL</code>, the next request for the default mail identity will return

1631

the mail identity named by the default mail account.

1632

1633

1634

If <code>extension_name</code> is <a class="link" href="ESourceMemoList.html#E-SOURCE-EXTENSION-MEMO-LIST:CAPS" title="E_SOURCE_EXTENSION_MEMO_LIST">E_SOURCE_EXTENSION_MEMO_LIST</a>, the function sets

1635

<code>default_source</code> as the default memo list. If <code>default_source</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,

1635

<code>default_source</code> as the default memo list. If <code>default_source</code> is <code class="literal">NULL</code>,

1636

the default memo list is reset to the built-in memo list.

1637

1638

1639

If <code>extension_name</code> is <a class="link" href="ESourceTaskList.html#E-SOURCE-EXTENSION-TASK-LIST:CAPS" title="E_SOURCE_EXTENSION_TASK_LIST">E_SOURCE_EXTENSION_TASK_LIST</a>, the function sets

1640

<code>default_source</code> as the default task list. If <code>default_source</code> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,

1640

<code>default_source</code> as the default task list. If <code>default_source</code> is <code class="literal">NULL</code>,

1641

the default task list is reset to the built-in task list.

1642

1643

1657

</tr>

1658

<tr>

1659

<td><code>default_source</code> :</td>

1660

<td>an <a class="link" href="ESource.html" title="ESource">ESource</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1660

<td>an <a class="link" href="ESource.html" title="ESource">ESource</a>, or <code class="literal">NULL</code>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

1661

</td>

1662

</tr>

1663

</tbody>

1721

<a name="ESourceRegistry-source-added"></a><h3>The <code class="literal">"source-added"</code> signal</h3>

1722

<pre class="programlisting">void user_function (<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry,

1723

<a class="link" href="ESource.html" title="ESource">ESource</a> *source,

1724

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

1724

gpointer user_data) : <code class="literal">Run Last</code></pre>

1725

1726

Emitted when an <a class="link" href="ESource.html" title="ESource">ESource</a> is added to <code>registry</code>.

1727

1749

<a name="ESourceRegistry-source-changed"></a><h3>The <code class="literal">"source-changed"</code> signal</h3>

1750

<pre class="programlisting">void user_function (<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry,

1751

<a class="link" href="ESource.html" title="ESource">ESource</a> *source,

1752

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

1752

gpointer user_data) : <code class="literal">Run Last</code></pre>

1753

1754

Emitted when an <a class="link" href="ESource.html" title="ESource">ESource</a> registered with <code>registry</code> emits

1755

its <a class="link" href="ESource.html#ESource-changed" title='The "changed" signal'>"changed"</a> signal.

1777

<a name="ESourceRegistry-source-disabled"></a><h3>The <code class="literal">"source-disabled"</code> signal</h3>

1778

<pre class="programlisting">void user_function (<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry,

1779

<a class="link" href="ESource.html" title="ESource">ESource</a> *source,

1780

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

1780

gpointer user_data) : <code class="literal">Run Last</code></pre>

1781

1782

Emitted when an <a class="link" href="ESource.html" title="ESource">ESource</a> <a class="link" href="ESource.html#ESource--enabled" title='The "enabled" property'>"enabled"</a> property becomes <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.

1782

Emitted when an <a class="link" href="ESource.html" title="ESource">ESource</a> <a class="link" href="ESource.html#ESource--enabled" title='The "enabled" property'>"enabled"</a> property becomes <code class="literal">FALSE</code>.

1783

1784

1785

1804

<a name="ESourceRegistry-source-enabled"></a><h3>The <code class="literal">"source-enabled"</code> signal</h3>

1805

<pre class="programlisting">void user_function (<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry,

1806

<a class="link" href="ESource.html" title="ESource">ESource</a> *source,

1807

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

1807

gpointer user_data) : <code class="literal">Run Last</code></pre>

1808

1809

Emitted when an <a class="link" href="ESource.html" title="ESource">ESource</a> <a class="link" href="ESource.html#ESource--enabled" title='The "enabled" property'>"enabled"</a> property becomes <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.

1809

Emitted when an <a class="link" href="ESource.html" title="ESource">ESource</a> <a class="link" href="ESource.html#ESource--enabled" title='The "enabled" property'>"enabled"</a> property becomes <code class="literal">TRUE</code>.

1810

1811

1812

1831

<a name="ESourceRegistry-source-removed"></a><h3>The <code class="literal">"source-removed"</code> signal</h3>

1832

<pre class="programlisting">void user_function (<a class="link" href="ESourceRegistry.html" title="ESourceRegistry">ESourceRegistry</a> *registry,

1833

<a class="link" href="ESource.html" title="ESource">ESource</a> *source,

1834

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

1834

gpointer user_data) : <code class="literal">Run Last</code></pre>

1835

1836

Emitted when an <a class="link" href="ESource.html" title="ESource">ESource</a> is removed from <code>registry</code>.

1837