return q;
}
+/**
+ * e_book_client_error_to_string:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
const gchar *
e_book_client_error_to_string (EBookClientError code)
{
* otherwise the given message is used.
*
* Returned pointer should be freed with g_error_free().
+ *
+ * Since: 3.2
**/
GError *
e_book_client_error_create (EBookClientError code,
#define E_IS_BOOK_CLIENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_TYPE_BOOK_CLIENT))
#define E_BOOK_CLIENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), E_TYPE_BOOK_CLIENT, EBookClientClass))
+/**
+ * BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS "required-fields"
+
+/**
+ * BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS "supported-fields"
+
+/**
+ * BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS "supported-auth-methods"
+/**
+ * E_BOOK_CLIENT_ERROR:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define E_BOOK_CLIENT_ERROR e_book_client_error_quark ()
GQuark e_book_client_error_quark (void) G_GNUC_CONST;
+/**
+ * EBookClientError:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
typedef enum {
E_BOOK_CLIENT_ERROR_NO_SUCH_BOOK,
E_BOOK_CLIENT_ERROR_CONTACT_NOT_FOUND,
typedef struct _EBookClientClass EBookClientClass;
typedef struct _EBookClientPrivate EBookClientPrivate;
+/**
+ * EBookClient:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _EBookClient {
EClient parent;
* Creates a new #EContactPhoto struct.
*
* Returns: (transfer full): A new #EContactPhoto struct.
+ *
+ * Since: 3.2
**/
EContactPhoto *
e_contact_photo_new (void)
*
* Returns: (transfer none) (array length=len): the inlined image in the
* #EContactPhoto.
+ *
+ * Since: 3.2
**/
const guchar *
e_contact_photo_get_inlined (EContactPhoto *photo,
* @len: the length of @data
*
* Sets the @photo's inlined data.
+ *
+ * Since: 3.2
**/
void
e_contact_photo_set_inlined (EContactPhoto *photo,
* Gets the @photo's mime type.
*
* Returns: (transfer none): the mime type of the image
+ *
+ * Since: 3.2
**/
const gchar *
e_contact_photo_get_mime_type (EContactPhoto *photo)
* @mime_type: the mime type
*
* Sets the @photo's mime type.
+ *
+ * Since: 3.2
**/
void
e_contact_photo_set_mime_type (EContactPhoto *photo,
* Gets the @photo's URI.
*
* Returns: (transfer none): the URI of the image
+ *
+ * Since: 3.2
**/
const gchar *
e_contact_photo_get_uri (EContactPhoto *photo)
* @uri: the @photo's URI
*
* Sets the @photo's URI.
+ *
+ * Since: 3.2
**/
void
e_contact_photo_set_uri (EContactPhoto *photo,
* Creates a new #EContactAddress struct.
*
* Returns: (transfer full): A new #EContactAddress struct.
+ *
+ * Since: 3.2
**/
EContactAddress *
e_contact_address_new (void)
*
* Specify the source @dest's contact comes from. This is useful
* if you need to update the contact later.
+ *
+ * Since: 3.2
**/
void
e_destination_set_client (EDestination *dest,
* The list and its elements belong to @dest, and should not be freed.
*
* Returns: (element-type EDestination) (transfer none): A list of elements of type #EDestination, or %NULL.
+ *
+ * Since: 3.2
**/
const GList *
e_destination_list_get_root_dests (const EDestination *dest)
* Check if the @evc has been parsed already. Used for debugging.
*
* Return value: %TRUE if @evc has been parsed, %FALSE otherwise.
+ *
+ * Since: 3.2
**/
gboolean
e_vcard_is_parsed (EVCard *evc)
#define EVC_X_JABBER "X-JABBER"
#define EVC_X_LIST_SHOW_ADDRESSES "X-EVOLUTION-LIST-SHOW-ADDRESSES"
#define EVC_X_LIST "X-EVOLUTION-LIST"
+
+/**
+ * EVC_X_LIST_NAME:
+ *
+ * Since: 3.2
+ **/
#define EVC_X_LIST_NAME "X-EVOLUTION-LIST-NAME"
+
#define EVC_X_MANAGER "X-EVOLUTION-MANAGER"
#define EVC_X_MSN "X-MSN"
#define EVC_X_RADIO "X-EVOLUTION-RADIO"
#define EVC_X_BOOK_URI "X-EVOLUTION-BOOK-URI"
/* Constants for Evo contact lists only */
+
+/**
+ * EVC_CONTACT_LIST
+ *
+ * Since: 3.2
+ **/
#define EVC_CONTACT_LIST "X-EVOLUTION-CONTACT-LIST-INFO"
+
+/**
+ * EVC_PARENT_CL:
+ *
+ * Since: 3.2
+ **/
#define EVC_PARENT_CL "X-EVOLUTION-PARENT-UID"
+
+/**
+ * EVC_CL_UID:
+ *
+ * Since: 3.2
+ **/
#define EVC_CL_UID "X-EVOLUTION-CONTACT-LIST-UID"
#ifndef EDS_DISABLE_DEPRECATED
* would be stored in same db in different tables.
*
* Returns:
+ *
+ * Since: 3.2
**/
EBookBackendSqliteDB *
e_book_backend_sqlitedb_new (const gchar *path,
* which is the preferred means to add multiple contacts when possible.
*
* Returns: TRUE on success.
+ *
+ * Since: 3.2
**/
gboolean
e_book_backend_sqlitedb_add_contact (EBookBackendSqliteDB *ebsdb,
*
*
* Returns: TRUE on success.
+ *
+ * Since: 3.2
**/
gboolean
e_book_backend_sqlitedb_add_contacts (EBookBackendSqliteDB *ebsdb,
return ret && !err;
}
+/**
+ * e_book_backend_sqlitedb_remove_contact:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_remove_contact (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
error);
}
+/**
+ * e_book_backend_sqlitedb_remove_contacts:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_remove_contacts (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return 0;
}
+/**
+ * e_book_backend_sqlitedb_has_contact:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_has_contact (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return 0;
}
+/**
+ * e_book_backend_sqlitedb_get_contact:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
EContact *
e_book_backend_sqlitedb_get_contact (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
}
}
+/**
+ * e_book_backend_sqlitedb_is_summary_fields:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_is_summary_fields (GHashTable *fields_of_interest)
{
* the returned vcard string satisfies the passed 'fields_of_interest' parameter.
*
* Returns: (transfer full): The vcard string for @uid or %NULL if @uid was not found.
+ *
+ * Since: 3.2
*/
gchar *
e_book_backend_sqlitedb_get_vcard_string (EBookBackendSqliteDB *ebsdb,
{ "exists", func_check, 0 }
};
+/**
+ * e_book_backend_sqlitedb_is_summary_query:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_is_summary_query (const gchar *query)
{
* and fetch for full required data from another persistance.
*
* Returns: List of EbSdbSearchData.
+ *
+ * Since: 3.2
**/
GSList *
e_book_backend_sqlitedb_search (EBookBackendSqliteDB *ebsdb,
return search_contacts;
}
+/**
+ * e_book_backend_sqlitedb_search_uids:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
GSList *
e_book_backend_sqlitedb_search_uids (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return 0;
}
+/**
+ * e_book_backend_sqlitedb_get_is_populated:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_get_is_populated (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
}
+/**
+ * e_book_backend_sqlitedb_set_is_populated:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_set_is_populated (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
*
* Returns: TRUE if the vcards stored in the db were downloaded partially. It is to indicate
* the stored vcards does not contain the full data.
+ *
+ * Since: 3.2
**/
gboolean
e_book_backend_sqlitedb_get_has_partial_content (EBookBackendSqliteDB *ebsdb,
return ret;
}
+/**
+ * e_book_backend_sqlitedb_set_has_partial_content:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_set_has_partial_content (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return 0;
}
+/**
+ * e_book_backend_sqlitedb_get_contact_bdata:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gchar *
e_book_backend_sqlitedb_get_contact_bdata (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return ret;
}
+/**
+ * e_book_backend_sqlitedb_set_contact_bdata:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_set_contact_bdata (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return !err;
}
+/**
+ * e_book_backend_sqlitedb_get_sync_data:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gchar *
e_book_backend_sqlitedb_get_sync_data (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return ret;
}
+/**
+ * e_book_backend_sqlitedb_set_sync_data:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_set_sync_data (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return !err;
}
+/**
+ * e_book_backend_sqlitedb_get_key_value:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gchar *
e_book_backend_sqlitedb_get_key_value (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return ret;
}
+/**
+ * e_book_backend_sqlitedb_set_key_value:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_set_key_value (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return !err;
}
+/**
+ * e_book_backend_sqlitedb_get_partially_cached_ids:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
GSList *
e_book_backend_sqlitedb_get_partially_cached_ids (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return uids;
}
+/**
+ * e_book_backend_sqlitedb_delete_addressbook:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_delete_addressbook (EBookBackendSqliteDB *ebsdb,
const gchar *folderid,
return !err;
}
+/**
+ * e_book_backend_sqlitedb_search_data_free:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_book_backend_sqlitedb_search_data_free (EbSdbSearchData *s_data)
{
}
}
+/**
+ * e_book_backend_sqlitedb_remove:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gboolean
e_book_backend_sqlitedb_remove (EBookBackendSqliteDB *ebsdb,
GError **error)
typedef struct _EBookBackendSqliteDBClass EBookBackendSqliteDBClass;
typedef struct _EBookBackendSqliteDBPrivate EBookBackendSqliteDBPrivate;
+/**
+ * EBookBackendSqliteDB:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _EBookBackendSqliteDB {
GObject parent;
EBookBackendSqliteDBPrivate *priv;
/* virtual methods */
};
+/**
+ * EbSdbSearchData:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
typedef struct {
gchar *vcard;
gchar *uid;
* @error: #GError to set, when something fails
*
* Opens @backend, which can involve connecting it to a remote server.
+ *
+ * Since: 3.2
**/
void
e_book_backend_sync_open (EBookBackendSync *backend,
*
* Calls @callback for each known book view of this @backend.
* @callback returns %FALSE to stop further processing.
+ *
+ * Since: 3.2
**/
void
e_book_backend_foreach_view (EBookBackend *backend,
* Checks if @backend's storage is online.
*
* Returns: %TRUE if online, %FALSE otherwise.
+ *
+ * Since: 3.2
**/
gboolean
e_book_backend_is_online (EBookBackend *backend)
* within call of e_book_backend_notify_opened().
*
* Returns: %TRUE if fully opened, %FALSE otherwise.
+ *
+ * Since: 3.2
**/
gboolean
e_book_backend_is_opened (EBookBackend *backend)
* it is being opening.
*
* Returns: %TRUE if opening phase is in the effect, %FALSE otherwise.
+ *
+ * Since: 3.2
**/
gboolean
e_book_backend_is_opening (EBookBackend *backend)
* Checks if we can write to @backend.
*
* Returns: %TRUE if writeable, %FALSE if not.
+ *
+ * Since: 3.2
**/
gboolean
e_book_backend_is_readonly (EBookBackend *backend)
* Notifies each backend listener about an error. This is meant to be used
* for cases where is no GError return possibility, to notify user about
* an issue.
+ *
+ * Since: 3.2
**/
void
e_book_backend_notify_error (EBookBackend *backend,
* @is_readonly: flag indicating readonly status
*
* Notifies all backend's clients about the current readonly state.
+ *
+ * Since: 3.2
**/
void
e_book_backend_notify_readonly (EBookBackend *backend,
*
* Notifies clients of @backend's connection status indicated by @is_online.
* Meant to be used by backend implementations.
+ *
+ * Since: 3.2
**/
void
e_book_backend_notify_online (EBookBackend *backend,
* Note: The @error is freed automatically if not %NULL.
*
* Meant to be used by backend implementations.
+ *
+ * Since: 3.2
**/
void
e_book_backend_notify_opened (EBookBackend *backend,
* @prop_value: new property value
*
* Notifies clients about property value change.
+ *
+ * Since: 3.2
**/
void
e_book_backend_notify_property_changed (EBookBackend *backend,
* and e_data_book_respond_open() with the same @error.
*
* See e_book_backend_open() for more details how the opening phase works.
+ *
+ * Since: 3.2
**/
void
e_book_backend_respond_opened (EBookBackend *backend,
#define E_IS_BOOK_BACKEND_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_TYPE_BOOK_BACKEND))
#define E_BOOK_BACKEND_GET_CLASS(k) (G_TYPE_INSTANCE_GET_CLASS ((k), E_TYPE_BOOK_BACKEND, EBookBackendClass))
+/**
+ * CLIENT_BACKEND_PROPERTY_OPENED:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_OPENED "opened"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_OPENING:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_OPENING "opening"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_ONLINE:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_ONLINE "online"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_READONLY:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_READONLY "readonly"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_CACHE_DIR:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_CACHE_DIR "cache-dir"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_CAPABILITIES:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_CAPABILITIES "capabilities"
+
+/**
+ * BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define BOOK_BACKEND_PROPERTY_REQUIRED_FIELDS "required-fields"
+
+/**
+ * BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define BOOK_BACKEND_PROPERTY_SUPPORTED_FIELDS "supported-fields"
+
+/**
+ * BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define BOOK_BACKEND_PROPERTY_SUPPORTED_AUTH_METHODS "supported-auth-methods"
typedef struct _EBookBackendPrivate EBookBackendPrivate;
* @is_online: Online mode to set.
*
* Sets the online mode for all backends created by the given factory.
+ *
+ * Since: 3.2
*/
void
e_data_book_factory_set_backend_online (EDataBookFactory *factory,
* Provides listeners with a human-readable text describing the
* current backend operation. This can be used for progress
* reporting.
+ *
+ * Since: 3.2
**/
void
e_data_book_view_notify_progress (EDataBookView *book_view,
g_error_free (error);
}
-/* takes a list of strings and converts it to a comma-separated string of values;
- * free returned pointer with g_free () */
+/**
+ * e_data_book_string_slist_to_comma_string:
+ *
+ * Takes a list of strings and converts it to a comma-separated string of
+ * values; free returned pointer with g_free()
+ *
+ * Since: 3.2
+ **/
gchar *
e_data_book_string_slist_to_comma_string (const GSList *strings)
{
g_error_free (error);
}
+/**
+ * e_data_book_respond_get_backend_property:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_respond_get_backend_property (EDataBook *book,
guint32 opid,
g_free (gdbus_prop_value);
}
+/**
+ * e_data_book_respond_set_backend_property:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_respond_set_backend_property (EDataBook *book,
guint32 opid,
}
}
+/**
+ * e_data_book_respond_get_contact_list_uids:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_respond_get_contact_list_uids (EDataBook *book,
guint32 opid,
}
+/**
+ * e_data_book_report_error:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_report_error (EDataBook *book,
const gchar *message)
e_gdbus_book_emit_backend_error (book->priv->gdbus_object, message);
}
+/**
+ * e_data_book_report_readonly:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_report_readonly (EDataBook *book,
gboolean readonly)
e_gdbus_book_emit_readonly (book->priv->gdbus_object, readonly);
}
+/**
+ * e_data_book_report_online:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_report_online (EDataBook *book,
gboolean is_online)
g_strfreev (strv);
}
-/* Reports to associated client that opening phase of the book is finished.
- * error being NULL means successfully, otherwise reports an error which happened
- * during opening phase. By opening phase is meant a process including successfull
- * authentication to the server/storage.
- */
+/**
+ * e_data_book_report_opened:
+ *
+ * Reports to associated client that opening phase of the book is finished.
+ * error being NULL means successfully, otherwise reports an error which
+ * happened during opening phase. By opening phase is meant a process
+ * including successfull authentication to the server/storage.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_report_opened (EDataBook *book,
const GError *error)
g_strfreev (strv_error);
}
-/* Notifies client about certain property value change */
+/**
+ * e_data_book_report_backend_property_changed:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_book_report_backend_property_changed (EDataBook *book,
const gchar *prop_name,
{
gchar **strv;
+ /* Notifies client about certain property value change */
+
g_return_if_fail (book != NULL);
g_return_if_fail (prop_name != NULL);
g_return_if_fail (*prop_name != '\0');
* Get the #ECalClient associated with this view.
*
* Returns: the associated client.
+ *
+ * Since: 3.2
**/
ECalClient *
e_cal_client_view_get_client (ECalClientView *view)
*
* Retunrs: Whether view is running. Not running views are ignoring
* all events sent from the server.
+ *
+ * Since: 3.2
**/
gboolean
e_cal_client_view_is_running (ECalClientView *view)
* @error: A #Gerror
*
* Starts a live query to the calendar/tasks backend.
+ *
+ * Since: 3.2
**/
void
e_cal_client_view_start (ECalClientView *view,
* @error: A #GError
*
* Stops a live query to the calendar/tasks backend.
+ *
+ * Since: 3.2
*/
void
e_cal_client_view_stop (ECalClientView *view,
struct _ECalClient;
+/**
+ * ECalClientView:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _ECalClientView {
GObject object;
return q;
}
+/**
+ * e_cal_client_error_to_string:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
const gchar *
e_cal_client_error_to_string (ECalClientError code)
{
* otherwise the given message is used.
*
* Returned pointer should be freed with g_error_free().
+ *
+ * Since: 3.2
**/
GError *
e_cal_client_error_create (ECalClientError code,
*
* Returns: The timezone identified by the @tzid argument, or %NULL if
* it could not be found.
+ *
+ * Since: 3.2
*/
icaltimezone *
e_cal_client_resolve_tzid_cb (const gchar *tzid,
#define E_IS_CAL_CLIENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_TYPE_CAL_CLIENT))
#define E_CAL_CLIENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), E_TYPE_CAL_CLIENT, ECalClientClass))
+/**
+ * CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS "cal-email-address"
+
+/**
+ * CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS "alarm-email-address"
+
+/**
+ * CAL_BACKEND_PROPERTY_DEFAULT_OBJECT:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CAL_BACKEND_PROPERTY_DEFAULT_OBJECT "default-object"
+/**
+ * ECalClientSourceType:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
typedef enum {
E_CAL_CLIENT_SOURCE_TYPE_EVENTS,
E_CAL_CLIENT_SOURCE_TYPE_TASKS,
GType e_cal_client_source_type_enum_get_type (void);
+/**
+ * E_CAL_CLIENT_ERROR:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CAL_CLIENT_ERROR e_cal_client_error_quark ()
GQuark e_cal_client_error_quark (void) G_GNUC_CONST;
+/**
+ * ECalClientError:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
typedef enum {
E_CAL_CLIENT_ERROR_NO_SUCH_CALENDAR,
E_CAL_CLIENT_ERROR_OBJECT_NOT_FOUND,
typedef struct _ECalClientClass ECalClientClass;
typedef struct _ECalClientPrivate ECalClientPrivate;
+/**
+ * ECalClient:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _ECalClient {
EClient parent;
#define CAL_STATIC_CAPABILITY_NO_THISANDFUTURE "no-thisandfuture"
#define CAL_STATIC_CAPABILITY_NO_THISANDPRIOR "no-thisandprior"
#define CAL_STATIC_CAPABILITY_NO_TRANSPARENCY "no-transparency"
+
+/**
+ * CAL_STATIC_CAPABILITY_REMOVE_ONLY_THIS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CAL_STATIC_CAPABILITY_REMOVE_ONLY_THIS "remove-only-this"
+
#define CAL_STATIC_CAPABILITY_ONE_ALARM_ONLY "one-alarm-only"
#define CAL_STATIC_CAPABILITY_ORGANIZER_MUST_ATTEND "organizer-must-attend"
#define CAL_STATIC_CAPABILITY_ORGANIZER_NOT_EMAIL_ADDRESS "organizer-not-email-address"
E_CAL_LOAD_LOADED
} ECalLoadState;
+/**
+ * EDataCalMode:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
typedef enum {
Local = 1 << 0,
Remote = 1 << 1,
* @error: #GError to set, when something fails
*
* Authenticates @backend with given @credentials.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_sync_authenticate_user (ECalBackendSync *backend,
* @error: Out parameter for a #GError.
*
* Calls the get_attachment_uris_sync method on the given backend.
+ *
+ * Since: 3.2
*/
void
e_cal_backend_sync_get_attachment_uris (ECalBackendSync *backend,
* @backend: an #ECalBackend
*
* Returns: Whether is backend online.
+ *
+ * Since: 3.2
**/
gboolean
e_cal_backend_is_online (ECalBackend *backend)
* within call of e_cal_backend_notify_opened().
*
* Returns: %TRUE if fully opened, %FALSE otherwise.
+ *
+ * Since: 3.2
**/
gboolean
e_cal_backend_is_opened (ECalBackend *backend)
}
/**
- * e_cal_backend_is_opening::
+ * e_cal_backend_is_opening:
* @backend: an #ECalBackend
*
* Checks if @backend is processing its opening phase, which
* it is being opening.
*
* Returns: %TRUE if opening phase is in the effect, %FALSE otherwise.
+ *
+ * Since: 3.2
**/
gboolean
e_cal_backend_is_opening (ECalBackend *backend)
*
* Returns: Whether is backend read-only. This value is the last used
* in a call of e_cal_backend_notify_readonly().
+ *
+ * Since: 3.2
**/
gboolean
e_cal_backend_is_readonly (ECalBackend *backend)
* Checks if @backend has been removed from its physical storage.
*
* Returns: %TRUE if @backend has been removed, %FALSE otherwise.
+ *
+ * Since: 3.2
**/
gboolean
e_cal_backend_is_removed (ECalBackend *backend)
*
* Sets the flag indicating whether @backend was removed to @is_removed.
* Meant to be used by backend implementations.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_set_is_removed (ECalBackend *backend,
* Adds a view to the list of live views being run by the given backend.
* Doing so means that any listener on the view will get notified of any
* change that affect the live view.
+ *
+ * Since: 3.2
*/
void
e_cal_backend_add_view (ECalBackend *backend,
*
* Removes view from the list of live views for the backend.
*
- * Since: 2.24
+ * Since: 3.2
**/
void
e_cal_backend_remove_view (ECalBackend *backend,
*
* Calls @callback for each known calendar view of this @backend.
* @callback returns %FALSE to stop further processing.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_foreach_view (ECalBackend *backend,
* @proxy: The calendar backend to act as notification proxy.
*
* Sets the backend that will act as notification proxy for the given backend.
+ *
+ * Since: 3.2
*/
void
e_cal_backend_set_notification_proxy (ECalBackend *backend,
* @is_online: Whether is online
*
* Sets the online mode of the calendar
+ *
+ * Since: 3.2
*/
void
e_cal_backend_set_online (ECalBackend *backend,
*
* See information at e_cal_backend_open() for more details
* how the opening phase works.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_authenticate_user (ECalBackend *backend,
* Queries a calendar backend for attachments present in a calendar object based
* on its unique identifier and its recurrence ID (if a recurrent appointment).
* This might be finished with e_data_cal_respond_get_attachment_uris().
+ *
+ * Since: 3.2
**/
void
e_cal_backend_get_attachment_uris (ECalBackend *backend,
* @view: The view to be started.
*
* Starts a new live view on the given backend.
+ *
+ * Since: 3.2
*/
void
e_cal_backend_start_view (ECalBackend *backend,
*
* Notifies clients of @backend's connection status indicated by @is_online.
* Meant to be used by backend implementations.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_notify_online (ECalBackend *backend,
* Note: The @error is freed automatically if not %NULL.
*
* Meant to be used by backend implementations.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_notify_opened (ECalBackend *backend,
* @prop_value: new property value
*
* Notifies client about property value change.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_notify_property_changed (ECalBackend *backend,
* e_data_cal_respond_open() with the same @error.
*
* See e_cal_backend_open() for more details how the opening phase works.
+ *
+ * Since: 3.2
**/
void
e_cal_backend_respond_opened (ECalBackend *backend,
#define E_IS_CAL_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_CAL_BACKEND))
#define E_CAL_BACKEND_GET_CLASS(obj) (E_CAL_BACKEND_CLASS (G_OBJECT_GET_CLASS (obj)))
+/**
+ * CLIENT_BACKEND_PROPERTY_OPENED:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_OPENED "opened"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_OPENING:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_OPENING "opening"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_ONLINE:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_ONLINE "online"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_READONLY:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_READONLY "readonly"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_CACHE_DIR:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_CACHE_DIR "cache-dir"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_CAPABILITIES:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_CAPABILITIES "capabilities"
+
+/**
+ * CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CAL_BACKEND_PROPERTY_CAL_EMAIL_ADDRESS "cal-email-address"
+
+/**
+ * CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CAL_BACKEND_PROPERTY_ALARM_EMAIL_ADDRESS "alarm-email-address"
+
+/**
+ * CAL_BACKEND_PROPERTY_DEFAULT_OBJECT:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define CAL_BACKEND_PROPERTY_DEFAULT_OBJECT "default-object"
struct _ECalBackendCache;
* @is_online: Online mode to set.
*
* Sets the online mode for all backends created by the given factory.
+ *
+ * Since: 3.2
*/
void
e_data_cal_factory_set_backend_online (EDataCalFactory *factory,
* if there are changes in the objects matching the view search expression.
*
* Returns: TRUE if the view is completed, FALSE if still in progress.
+ *
+ * Since: 3.2
*/
gboolean
e_data_cal_view_is_completed (EDataCalView *view)
* Note: The data pointer in the hash table has no special meaning, it's
* only GINT_TO_POINTER(1) for easier checking. Also, field names are
* compared case insensitively.
+ *
+ * Since: 3.2
**/
/* const */ GHashTable *
e_data_cal_view_get_fields_of_interest (EDataCalView *view)
*
* Notifies all view listeners of the completion of the view, including a
* status code.
- */
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_view_notify_complete (EDataCalView *view,
const GError *error)
}
/**
- * e_data_cal_notify_open:
+ * e_data_cal_respond_open:
* @cal: A calendar client interface.
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the open method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_open (EDataCal *cal,
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the remove method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_remove (EDataCal *cal,
*
* Notifies listeners of the completion of the refresh method call.
*
- * Since: 2.30
+ * Since: 3.2
*/
void
e_data_cal_respond_refresh (EDataCal *cal,
* @prop_value: Value of a property
*
* Notifies listeners of the completion of the get_backend_property method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_get_backend_property (EDataCal *cal,
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the set_backend_property method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_set_backend_property (EDataCal *cal,
* @object: The object retrieved as an iCalendar string.
*
* Notifies listeners of the completion of the get_object method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_get_object (EDataCal *cal,
* @objects: List of retrieved objects.
*
* Notifies listeners of the completion of the get_object_list method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_get_object_list (EDataCal *cal,
*
* Notifies listeners of the completion of the get_free_busy method call.
* To pass actual free/busy objects to the client use e_data_cal_report_free_busy_data().
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_get_free_busy (EDataCal *cal,
* @object: The object created as an iCalendar string.
*
* Notifies listeners of the completion of the create_object method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_create_object (EDataCal *cal,
* @object: The modified object as an iCalendar string.
*
* Notifies listeners of the completion of the modify_object method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_modify_object (EDataCal *cal,
* when removing instances of a recurring appointment.
*
* Notifies listeners of the completion of the remove_object method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_remove_object (EDataCal *cal,
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the receive_objects method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_receive_objects (EDataCal *cal,
* @calobj: An iCalendar string representing the object sent.
*
* Notifies listeners of the completion of the send_objects method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_send_objects (EDataCal *cal,
* @attachment_uris: List of retrieved attachment uri's.
*
* Notifies listeners of the completion of the get_attachment_uris method call.
+ *
+ * Since: 3.2
**/
void
e_data_cal_respond_get_attachment_uris (EDataCal *cal,
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the discard_alarm method call.
+ *
+ * Since: 3.2
**/
void
e_data_cal_respond_discard_alarm (EDataCal *cal,
* @view_path: The new live view path.
*
* Notifies listeners of the completion of the get_view method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_get_view (EDataCal *cal,
* @tzobject: The requested timezone as an iCalendar string.
*
* Notifies listeners of the completion of the get_timezone method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_get_timezone (EDataCal *cal,
}
/**
- * e_data_cal_notify_timezone_added:
+ * e_data_cal_respond_add_timezone:
* @cal: A calendar client interface.
* @error: Operation error, if any, automatically freed if passed it.
*
* Notifies listeners of the completion of the add_timezone method call.
+ *
+ * Since: 3.2
*/
void
e_data_cal_respond_add_timezone (EDataCal *cal,
g_error_free (error);
}
+/**
+ * e_data_cal_report_error:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_report_error (EDataCal *cal,
const gchar *message)
e_gdbus_cal_emit_backend_error (cal->priv->gdbus_object, message);
}
+/**
+ * e_data_cal_report_readonly:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_report_readonly (EDataCal *cal,
gboolean readonly)
e_gdbus_cal_emit_readonly (cal->priv->gdbus_object, readonly);
}
+/**
+ * e_data_cal_report_online:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_report_online (EDataCal *cal,
gboolean is_online)
e_gdbus_cal_emit_online (cal->priv->gdbus_object, is_online);
}
-/* credentilas contains extra information for a source for which authentication is requested.
- * This parameter can be NULL to indicate "for this calendar".
-*/
+/**
+ * e_data_cal_report_auth_required:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_report_auth_required (EDataCal *cal,
const ECredentials *credentials)
gchar *empty_strv[2];
gchar **strv = NULL;
+ /* credentilas contains extra information for a source for which
+ * authentication is requested. This parameter can be NULL to
+ * indicate "for this calendar". */
+
g_return_if_fail (cal != NULL);
empty_strv[0] = NULL;
g_strfreev (strv);
}
-/* Reports to associated client that opening phase of the cal is finished.
- * error being NULL means successfully, otherwise reports an error which happened
- * during opening phase. By opening phase is meant a process including successfull
- * authentication to the server/storage.
- */
+/**
+ * e_data_cal_report_opened:
+ *
+ * Reports to associated client that opening phase of the cal is finished.
+ * error being NULL means successfully, otherwise reports an error which
+ * happened during opening phase. By opening phase is meant a process
+ * including successfull authentication to the server/storage.
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_report_opened (EDataCal *cal,
const GError *error)
g_strfreev (strv_error);
}
+/**
+ * e_data_cal_report_free_busy_data:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_report_free_busy_data (EDataCal *cal,
const GSList *freebusy)
g_strfreev (strv_freebusy);
}
-/* Notifies client about certain property value change */
+/**
+ * e_data_cal_report_backend_property_changed:
+ *
+ * Notifies client about certain property value change
+ *
+ * Since: 3.2
+ **/
void
e_data_cal_report_backend_property_changed (EDataCal *cal,
const gchar *prop_name,
* @path: Path to the (sub) cache the item exists in.
*
* Clear cache's content in @path.
+ *
+ * Since: 3.2
**/
void
camel_data_cache_clear (CamelDataCache *cdc,
CAMEL_FETCH_HEADERS_ALL
} CamelFetchHeadersType;
+/**
+ * CamelJunkStatus:
+ * @CAMEL_JUNK_STATUS_INCONCLUSIVE:
+ * The junk filter could not determine whether the message is junk.
+ * @CAMEL_JUNK_STATUS_MESSAGE_IS_JUNK:
+ * The junk filter believes the message is junk.
+ * @CAMEL_JUNK_STATUS_MESSAGE_IS_NOT_JUNK:
+ * The junk filter believes the message is not junk.
+ *
+ * These are result codes used when passing messages through a junk filter.
+ **/
typedef enum {
CAMEL_JUNK_STATUS_INCONCLUSIVE,
CAMEL_JUNK_STATUS_MESSAGE_IS_JUNK,
return r;
}
-/* add or subtract given number of months to given time */
+/**
+ * camel_folder_search_util_add_months:
+ * @t: Initial time
+ * @months: number of months to add or subtract
+ *
+ * Increases time @t by the given number of months (or decreases, if
+ * @months is negative).
+ *
+ * Returns: a new #time_t value
+ *
+ * Since: 3.2
+ **/
time_t
camel_folder_search_util_add_months (time_t t,
gint months)
* can be obtained with camel_folder_get_full_name().
*
* Returns: the display name of the folder
+ *
+ * Since: 3.2
**/
const gchar *
camel_folder_get_display_name (CamelFolder *folder)
*
* Sets the display name for the folder.
*
- * Since: 2.32
+ * Since: 3.2
**/
void
camel_folder_set_display_name (CamelFolder *folder,
{
}
+/**
+ * camel_junk_filter_classify:
+ * @junk_filter: a #CamelJunkFilter
+ * @message: a #CamelMimeMessage
+ * @status: location to write the #CamelJunkStatus
+ * @cancellable: optional #GCancellable object, or %NULL
+ * @error: return location for a #GError, or %NULL
+ *
+ * Classifies @message as junk, not junk or inconclusive.
+ *
+ * If an error occurs, the function sets @error and returns %FALSE.
+ *
+ * Returns: %TRUE if @message was successfully classified
+ *
+ * Since: 3.2
+ **/
gboolean
camel_junk_filter_classify (CamelJunkFilter *junk_filter,
CamelMimeMessage *message,
junk_filter, message, status, cancellable, error);
}
+/**
+ * camel_junk_filter_learn_junk:
+ * @junk_filter: a #CamelJunkFilter
+ * @message: a #CamelMimeMessage
+ * @cancellable: optional #GCancellable object, or %NULL
+ * @error: return location for a #GError, or %NULL
+ *
+ * Instructs @junk_filter to classify @message as junk. If using an
+ * adaptive junk filtering algorithm, explicitly marking @message as
+ * junk will influence the classification of future messages.
+ *
+ * If an error occurs, the function sets @error and returns %FALSE.
+ *
+ * Returns: %TRUE if @message was successfully classified
+ *
+ * Since: 3.2
+ **/
gboolean
camel_junk_filter_learn_junk (CamelJunkFilter *junk_filter,
CamelMimeMessage *message,
junk_filter, message, cancellable, error);
}
+/**
+ * camel_junk_filter_learn_not_junk:
+ * @junk_filter: a #CamelJunkFilter
+ * @message: a #CamelMimeMessage
+ * @cancellable: optional #GCancellable object, or %NULL
+ * @error: return location for a #GError, or %NULL
+ *
+ * Instructs @junk_filter to classify @message as not junk. If using an
+ * adaptive junk filtering algorithm, explicitly marking @message as not
+ * junk will influence the classification of future messages.
+ *
+ * If an error occurs, the function sets @error and returns %FALSE.
+ *
+ * Returns: %TRUE if @message was successfully classified
+ *
+ * Since: 3.2
+ **/
gboolean
camel_junk_filter_learn_not_junk (CamelJunkFilter *junk_filter,
CamelMimeMessage *message,
junk_filter, message, cancellable, error);
}
+/**
+ * camel_junk_filter_synchronize:
+ * @junk_filter: a #CamelJunkFilter
+ * @cancellable: optional #GCancellable object, or %NULL
+ * @error: return location for a #GError, or %NULL
+ *
+ * Instructs @junk_filter to flush any in-memory caches to disk, if
+ * applicable. When filtering many messages, delaying this step until
+ * all messages have been classified can improve performance.
+ *
+ * If an error occurs, the function sets @error and returns %FALSE.
+ *
+ * Returns: %TRUE if @junk_filter was successfully synchronized
+ *
+ * Since: 3.2
+ **/
gboolean
camel_junk_filter_synchronize (CamelJunkFilter *junk_filter,
GCancellable *cancellable,
G_BEGIN_DECLS
+/**
+ * CamelJunkFilter:
+ *
+ * Since: 3.2
+ **/
typedef struct _CamelJunkFilter CamelJunkFilter;
typedef struct _CamelJunkFilterInterface CamelJunkFilterInterface;
G_BEGIN_DECLS
+/**
+ * CamelNetworkService:
+ *
+ * Since: 3.2
+ **/
typedef struct _CamelNetworkService CamelNetworkService;
typedef struct _CamelNetworkServiceInterface CamelNetworkServiceInterface;
G_BEGIN_DECLS
+/**
+ * CamelNetworkSettings:
+ *
+ * Since: 3.2
+ **/
typedef struct _CamelNetworkSettings CamelNetworkSettings;
typedef struct _CamelNetworkSettingsInterface CamelNetworkSettingsInterface;
G_BEGIN_DECLS
+/**
+ * CamelOfflineSettings:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
typedef struct _CamelOfflineSettings CamelOfflineSettings;
typedef struct _CamelOfflineSettingsClass CamelOfflineSettingsClass;
typedef struct _CamelOfflineSettingsPrivate CamelOfflineSettingsPrivate;
const gchar *text, *value;
} CamelProviderConfEntry;
+/**
+ * CamelProviderPortEntry:
+ *
+ * Since: 3.2
+ **/
typedef struct {
gint port;
const gchar *desc;
* camel_session_add_service(). Free the returned list using g_list_free().
*
* Returns: an unsorted list of #CamelService objects
+ *
+ * Since: 3.2
**/
GList *
camel_session_list_services (CamelSession *session)
G_BEGIN_DECLS
+/**
+ * CamelSettings:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
typedef struct _CamelSettings CamelSettings;
typedef struct _CamelSettingsClass CamelSettingsClass;
typedef struct _CamelSettingsPrivate CamelSettingsPrivate;
G_BEGIN_DECLS
+/**
+ * CamelStoreSettings:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
typedef struct _CamelStoreSettings CamelStoreSettings;
typedef struct _CamelStoreSettingsClass CamelStoreSettingsClass;
typedef struct _CamelStoreSettingsPrivate CamelStoreSettingsPrivate;
G_BEGIN_DECLS
+/**
+ * CamelSubscribable:
+ *
+ * Since: 3.2
+ **/
typedef struct _CamelSubscribable CamelSubscribable;
typedef struct _CamelSubscribableInterface CamelSubscribableInterface;
<xi:include href="xml/e-data-server-module.xml"/>
<xi:include href="xml/e-db3-utils.xml"/>
<xi:include href="xml/e-offline-listener.xml"/>
+ <xi:include href="xml/e-sqlite3-vfs.xml"/>
</chapter>
<index>
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
+ <index id="api-index-3.2" role="3.2">
+ <title>Index of new symbols in 3.2</title>
+ <xi:include href="xml/api-index-3.2.xml"><xi:fallback /></xi:include>
+ </index>
<index id="api-index-2.30" role="2.30">
<title>Index of new symbols in 2.30</title>
<xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
<SECTION>
<FILE>e-operation-pool</FILE>
<TITLE>EOperationPool</TITLE>
+EOperationPool
e_operation_pool_new
e_operation_pool_free
e_operation_pool_reserve_opid
<!-- ##### SECTION Image ##### -->
+<!-- ##### STRUCT EOperationPool ##### -->
+<para>
+
+</para>
+
+
<!-- ##### FUNCTION e_operation_pool_new ##### -->
<para>
return NULL;
}
+/**
+ * e_sqlite3_vfs_init:
+ *
+ * Since: 3.2
+ **/
void
e_sqlite3_vfs_init (void)
{
return q;
}
+/**
+ * e_client_error_to_string:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
const gchar *
e_client_error_to_string (EClientError code)
{
* otherwise the given message is used.
*
* Returned pointer should be freed with g_error_free().
+ *
+ * Since: 3.2
**/
GError *
e_client_error_create (EClientError code,
* This list, together with inner strings, is owned by the @client.
* To check for individual capabilities use e_client_check_capability().
*
- * Returns: (element-type utf8) (transfer none): #GSList of const strings of capabilities
+ * Returns: (element-type utf8) (transfer none): #GSList of const strings
+ * of capabilities
*
* Since: 3.2
**/
* e_client_check_refresh_supported:
* @client: A client.
*
- * Checks whether a client supports explicit refreshing (see e_client_refresh()).
+ * Checks whether a client supports explicit refreshing
+ * (see e_client_refresh()).
*
* Returns: TRUE if the client supports refreshing, FALSE otherwise.
*
* @callback: callback to call when a result is ready
* @user_data: user data for the @callback
*
- * Removes the backing data for this #EClient. For example, with the file backend this
- * deletes the database file. You cannot get it back!
+ * Removes the backing data for this #EClient. For example, with the file
+ * backend this deletes the database file. You cannot get it back!
* The call is finished by e_client_remove_finish() from the @callback.
*
* Since: 3.2
* @cancellable: a #GCancellable; can be %NULL
* @error: (out): a #GError to set an error, if any
*
- * Removes the backing data for this #EClient. For example, with the file backend this
- * deletes the database file. You cannot get it back!
+ * Removes the backing data for this #EClient. For example, with the file
+ * backend this deletes the database file. You cannot get it back!
*
* Returns: %TRUE if successful, %FALSE otherwise.
*
*
* Note: Pair function for this is e_client_util_strv_to_slist().
*
- * Sice: 3.2
+ * Since: 3.2
**/
gchar **
e_client_util_slist_to_strv (const GSList *strings)
*
* Note: Pair function for this is e_client_util_slist_to_strv().
*
- * Sice: 3.2
+ * Since: 3.2
**/
GSList *
e_client_util_strv_to_slist (const gchar * const *strv)
*
* Frees memory previously allocated by e_client_util_strv_to_slist().
*
- * Sice: 3.2
+ * Since: 3.2
**/
void
e_client_util_free_string_slist (GSList *strings)
* Calls g_object_unref() on each member of @objects and then frees
* also @objects itself.
*
- * Sice: 3.2
+ * Since: 3.2
**/
void
e_client_util_free_object_slist (GSList *objects)
*
* Unwraps D-Bus error to local error. @dbus_error is automatically freed.
* @dbus_erorr and @out_error can point to the same variable.
+ *
+ * Since: 3.2
**/
void
e_client_unwrap_dbus_error (EClient *client,
* @known_errors_domain: Error domain for @known_errors
* @fail_when_none_matched: Whether to fail when none of @known_errors matches
*
- * The function takes a @dbus_error and tries to find a match in @known_errors for it,
- * if it is a G_IO_ERROR, G_IO_ERROR_DBUS_ERROR. If it is anything else then the @dbus_error
- * is moved to @client_error.
+ * The function takes a @dbus_error and tries to find a match in @known_errors
+ * for it, if it is a G_IO_ERROR, G_IO_ERROR_DBUS_ERROR. If it is anything else
+ * then the @dbus_error is moved to @client_error.
*
- * The @fail_when_none_matched influences behaviour. If it's %TRUE, and none of @known_errors matches,
- * or this is not a G_IO_ERROR_DBUS_ERROR, then %FALSE is returned and the @client_error
- * is left without change. Otherwise, the @fail_when_none_matched is %FALSE, the error is always
- * processed and will result in E_CLIENT_ERROR, E_CLIENT_ERROR_OTHER_ERROR if none of @known_error matches.
+ * The @fail_when_none_matched influences behaviour. If it's %TRUE, and none of
+ * @known_errors matches, or this is not a G_IO_ERROR_DBUS_ERROR, then %FALSE
+ * is returned and the @client_error is left without change. Otherwise, the
+ * @fail_when_none_matched is %FALSE, the error is always processed and will
+ * result in E_CLIENT_ERROR, E_CLIENT_ERROR_OTHER_ERROR if none of @known_error
+ * matches.
*
* Returns: Whether was @dbus_error processed into @client_error.
*
* Note: The @dbus_error is automatically freed if returned %TRUE.
+ *
+ * Since: 3.2
**/
gboolean
e_client_util_unwrap_dbus_error (GError *dbus_error,
#define E_IS_CLIENT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), E_TYPE_CLIENT))
#define E_CLIENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), E_TYPE_CLIENT, EClientClass))
+/**
+ * CLIENT_BACKEND_PROPERTY_OPENED:
+ *
+ * The "opened" property is "TRUE" when the client is fully opened,
+ * "FALSE" at all other times.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_OPENED "opened"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_OPENING:
+ *
+ * The "opening" property is "TRUE" when the client is in the process of
+ * opening, "FALSE" at all other times.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_OPENING "opening"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_ONLINE:
+ *
+ * The "online" property is "TRUE" when the client is fully opened and
+ * online, "FALSE" at all other times. See also e_client_is_online().
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_ONLINE "online"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_READONLY:
+ *
+ * The "online" property is "TRUE" if the backend has only read access
+ * to its data, "FALSE" if the backend can modify its data. See also
+ * e_client_is_readonly().
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_READONLY "readonly"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_CACHE_DIR:
+ *
+ * The "cache-dir" property indicates the backend's local directory for
+ * cached data.
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_CACHE_DIR "cache-dir"
+
+/**
+ * CLIENT_BACKEND_PROPERTY_CAPABILITIES:
+ *
+ * The "capabilities" property is a comma-separated list of capabilities
+ * supported by the backend. The preferred method of retrieving and working
+ * with capabilities is e_client_get_capabilities() and
+ * e_client_check_capability().
+ *
+ * Since: 3.2
+ **/
#define CLIENT_BACKEND_PROPERTY_CAPABILITIES "capabilities"
+/**
+ * E_CLIENT_ERROR:
+ *
+ * Error domain for #EClient operations. Errors in this domain will be
+ * from the #EClientError enumeration. See #GError for more information
+ * on error domains.
+ *
+ * Since: 3.2
+ **/
#define E_CLIENT_ERROR e_client_error_quark ()
G_BEGIN_DECLS
GQuark e_client_error_quark (void) G_GNUC_CONST;
+/**
+ * EClientError:
+ *
+ * FIXME Document each code.
+ *
+ * Error codes for #EClient operations.
+ *
+ * Since: 3.2
+ **/
typedef enum {
E_CLIENT_ERROR_INVALID_ARG,
E_CLIENT_ERROR_BUSY,
const gchar * e_client_error_to_string (EClientError code);
GError * e_client_error_create (EClientError code, const gchar *custom_msg);
+/**
+ * EClient:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
typedef struct _EClient EClient;
typedef struct _EClientClass EClientClass;
typedef struct _EClientPrivate EClientPrivate;
typedef struct _EClientErrorsList EClientErrorsList;
+/**
+ * EClientErrorsList:
+ *
+ * Since: 3.2
+ **/
struct _EClientErrorsList {
const gchar *name;
gint err_code;
return g_ascii_strcasecmp (str1, str2) == 0;
}
+/**
+ * e_credentials_new:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
ECredentials *
e_credentials_new (void)
{
return credentials;
}
-/* Expects @keys as NULL terminate list of strings "key:encoded_value".
- * The same can be returned from e_credentials_to_strv ().
-*/
+/**
+ * e_credentials_new_strv:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
ECredentials *
e_credentials_new_strv (const gchar * const *keys)
{
ECredentials *credentials;
gint ii;
+ /* Expects @keys as NULL terminated list of strings
+ * "key:encoded_value". The same can be returned from
+ * e_credentials_to_strv (). */
+
g_return_val_if_fail (keys != NULL, NULL);
credentials = e_credentials_new ();
return credentials;
}
-/* NULL-terminated list of string pairs <key, value>; value is in a clear form */
+/**
+ * e_credentials_new_args:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
ECredentials *
e_credentials_new_args (const gchar *key,
...)
ECredentials *credentials;
va_list va;
+ /* NULL-terminated list of string pairs <key, value>; value is
+ * in a clear form. */
+
g_return_val_if_fail (key != NULL, NULL);
credentials = e_credentials_new ();
g_hash_table_insert (hash_table, g_strdup (key), g_strdup (value));
}
+/**
+ * e_credentials_new_clone:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
ECredentials *
e_credentials_new_clone (const ECredentials *credentials)
{
return res;
}
+/**
+ * e_credentials_free:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_credentials_free (ECredentials *credentials)
{
}
}
-/* Returns NULL-terminated array of strings with keys and encoded values;
- * To read them back pass this pointer to e_credentials_new (). As it returns
- * newly allocated string then this should be freed with g_strfreev ()
- * when no longer needed.
-*/
+/**
+ * e_credentials_to_strv:
+ * @credentials: an #ECredentials
+ *
+ * Returns %NULL-terminated array of strings with keys and encoded values;
+ * To read them back pass this pointer to e_credentials_new(). As it returns
+ * newly allocated string then this should be freed with g_strfreev() when no
+ * longer needed.
+ *
+ * Returns: a %NULL-terminated array of key/value strings
+ *
+ * Since: 3.2
+ **/
gchar **
e_credentials_to_strv (const ECredentials *credentials)
{
return res;
}
-/* sets value for a key, if value is NULL or an empty string then the key is removed.
- * the value is supposed to be in a clear form (unencoded).
- * 'key' cannot contain colon.
-*/
+/**
+ * e_credentials_set:
+ * @credentials: an #ECredentials
+ * @key: a key string
+ * @value: a value string
+ *
+ * Sets value for @key, if @value is %NULL or an empty string then @key is
+ * removed. The value is supposed to be in a clear form (unencoded).
+ * @key cannot contain colon.
+ *
+ * Since: 3.2
+ **/
void
e_credentials_set (ECredentials *credentials,
const gchar *key,
}
}
-/* Returned pointer should be freed with e_credentials_util_safe_free_string()
- * when no longer needed.
-*/
+/**
+ * e_credentials_get:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gchar *
e_credentials_get (const ECredentials *credentials,
const gchar *key)
{
const gchar *stored;
+ /* Returned pointer should be freed with
+ * e_credentials_util_safe_free_string() when no longer needed. */
+
g_return_val_if_fail (credentials != NULL, NULL);
g_return_val_if_fail (credentials->priv != NULL, NULL);
g_return_val_if_fail (credentials->priv->keys != NULL, NULL);
return decode_string (stored);
}
-/* peeks value for a key, in a clear form. The value is valid until free
- * of the @credentials structure or until the key value is rewritten
- * by e_credentials_set ()
-*/
+/**
+ * e_credentials_peek:
+ * @credentials: an #ECredentials
+ * @key: a key string
+ *
+ * Peeks at the value for @key, in a clear form. The returned value is valid
+ * until free of the @credentials structure or until the key value is rewritten
+ * by e_credentials_set().
+ *
+ * Returns: the value for @key
+ *
+ * Since: 3.2
+ **/
const gchar *
e_credentials_peek (ECredentials *credentials,
const gchar *key)
ed->equal = ed->equal && g_strcmp0 (value, g_hash_table_lookup (ed->keys, key)) == 0;
}
-/* Returns whether two credential structurs contain the same keys with same values */
+/**
+ * e_credentials_equal:
+ * @credentials1: an #ECredentials
+ * @credentials2: another #ECredentials
+ *
+ * Returns whether two #ECredential structures contain the same keys with
+ * same values.
+ *
+ * Returns: %TRUE if they are equal, %FALSE otherwise
+ *
+ * Since: 3.2
+ **/
gboolean
e_credentials_equal (const ECredentials *credentials1,
const ECredentials *credentials2)
return ed.equal;
}
-/* Returns whether two credentials structures has same keys. Key names are NULL-terminated. */
+/**
+ * e_credentials_equal_keys:
+ * @credentials1: an #ECredentials
+ * @credentials2: another #ECredentials
+ *
+ * Returns whether two #ECredentials structures have the same keys. Key names
+ * are NULL-terminated.
+ *
+ * Returns: %TRUE if the key sets match, %FALSE otherwise
+ *
+ * Since: 3.2
+ **/
gboolean
e_credentials_equal_keys (const ECredentials *credentials1,
const ECredentials *credentials2,
}
/**
+ * e_credentials_has_key:
+ * @credentials: an #ECredentials
+ * @key: a key string
+ *
* Returns whether @credentials contains @key.
- * This key is non-NULL and non-empty string.
+ *
+ * Returns: %TRUE if @credentials contains @key, %FALSE otherwise
+ *
+ * Since: 3.2
**/
gboolean
e_credentials_has_key (const ECredentials *credentials,
return g_hash_table_lookup (credentials->priv->keys, key) != NULL;
}
+/**
+ * e_credentials_keys_size:
+ * @credentials: an #ECredentials
+ *
+ * Returns the number of keys in @credentials.
+ *
+ * Returns: the number of keys in @credentials
+ *
+ * Since: 3.2
+ **/
guint
e_credentials_keys_size (const ECredentials *credentials)
{
*slist = g_slist_prepend (*slist, key);
}
-/* Returns newly allocated list of key names stored in the credentials strucutre;
- * strings are internal credentials values, only the list is newly allocated.
- * Free the list with g_slist_free () when no longer needed.
-*/
+/**
+ * e_credentials_list_keys:
+ * @credentials: an #ECredentials
+ *
+ * Returns a newly-allocated #GSList of key names stored in @credentials.
+ * The key names are internal credentials values and should not be modified
+ * or freed. Free the list with g_slist_free() when no longer needed.
+ *
+ * Returns: a newly-allocated #GSList of key names
+ *
+ * Since: 3.2
+ **/
GSList *
e_credentials_list_keys (const ECredentials *credentials)
{
g_return_val_if_fail (credentials->priv != NULL, NULL);
g_return_val_if_fail (credentials->priv->keys != NULL, NULL);
+ /* XXX g_hash_table_get_keys() would have been
+ * easier had we used #GList instead. */
g_hash_table_foreach (credentials->priv->keys, gather_key_names, &keys);
return g_slist_reverse (keys);
}
-/* Removes all keys in once. */
+/**
+ * e_credentials_clear:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_credentials_clear (ECredentials *credentials)
{
g_hash_table_remove_all (credentials->priv->keys);
}
+/**
+ * e_credentials_clear_peek:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_credentials_clear_peek (ECredentials *credentials)
{
g_hash_table_remove_all (credentials->priv->peek_keys);
}
+/**
+ * e_credentials_util_safe_free_string:
+ *
+ * FIXME Document me.
+ *
+ * Since: 3.2
+ **/
void
e_credentials_util_safe_free_string (gchar *str)
{
{ E_CREDENTIALS_PROMPT_FLAG_PASSPHRASE, "passphrase", TRUE }
};
-/* Returned pointer can be passed to e_credentials_util_string_to prompt_flags()
- * to decode it back to flags. Free returned pointer with g_free ().
-*/
+/**
+ * e_credentials_util_prompt_flags_to_string:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
gchar *
e_credentials_util_prompt_flags_to_string (guint prompt_flags)
{
guint masked = prompt_flags & E_CREDENTIALS_PROMPT_FLAG_REMEMBER_MASK;
GString *str = g_string_new ("");
+ /* Returned pointer can be passed to
+ * e_credentials_util_string_to prompt_flags() to decode
+ * it back to flags. Free returned pointer with g_free(). */
+
for (ii = 0; ii < G_N_ELEMENTS (PromptFlags); ii++) {
const gchar *add = NULL;
return g_string_free (str, FALSE);
}
+/**
+ * e_credentials_util_string_to_prompt_flags:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
guint
e_credentials_util_string_to_prompt_flags (const gchar *prompt_flags_string)
{
typedef struct _ECredentials ECredentials;
typedef struct _ECredentialsPrivate ECredentialsPrivate;
+/**
+ * ECredentials:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _ECredentials {
ECredentialsPrivate *priv;
};
+/**
+ * E_CREDENTIALS_KEY_USERNAME:
+ *
+ * FIXME Docment me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_USERNAME "username"
+
+/**
+ * E_CREDENTIALS_KEY_PASSWORD:
+ *
+ * FIXME Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_PASSWORD "password"
+
+/**
+ * E_CREDENTIALS_KEY_AUTH_METHOD:
+ *
+ * FIXME Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_AUTH_METHOD "auth-method"
+
+/**
+ * E_CREDENTIALS_KEY_PROMPT_TITLE:
+ *
+ * FIXME Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_PROMPT_TITLE "prompt-title"
+
+/**
+ * E_CREDENTIALS_KEY_PROMPT_TEXT:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_PROMPT_TEXT "prompt-text"
+
+/**
+ * E_CREDENTIALS_KEY_PROMPT_REASON:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_PROMPT_REASON "prompt-reason"
+
+/**
+ * E_CREDENTIALS_KEY_PROMPT_KEY:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_PROMPT_KEY "prompt-key"
+
+/**
+ * E_CREDENTIALS_KEY_PROMPT_FLAGS:
+ *
+ * FIXME Document me.
+ *
+ * Since: 3.2
+ **/
#define E_CREDENTIALS_KEY_PROMPT_FLAGS "prompt-flags"
+/**
+ * ECredentialsPromptFlags:
+ *
+ * FIXME Document me.
+ *
+ * Since: 3.2
+ **/
/* this is 1:1 with EPasswordsRememberType */
typedef enum {
E_CREDENTIALS_PROMPT_FLAG_REMEMBER_NEVER,
G_UNLOCK (ptr_tracker);
}
+/**
+ * e_pointer_tracker_track_with_info:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_pointer_tracker_track_with_info (gpointer ptr,
const gchar *info)
G_UNLOCK (ptr_tracker);
}
+/**
+ * e_pointer_tracker_untrack:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_pointer_tracker_untrack (gpointer ptr)
{
G_UNLOCK (ptr_tracker);
}
+/**
+ * e_pointer_tracker_dump:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_pointer_tracker_dump (void)
{
void e_data_server_util_set_dbus_call_timeout
(gint timeout_msec);
-#define e_pointer_tracker_track(ptr) e_pointer_tracker_track_with_info (ptr, G_STRFUNC)
+/**
+ * e_pointer_tracker_track:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
+#define e_pointer_tracker_track(ptr) \
+ (e_pointer_tracker_track_with_info ((ptr), G_STRFUNC))
+
void e_pointer_tracker_track_with_info (gpointer ptr, const gchar *info);
void e_pointer_tracker_untrack (gpointer ptr);
void e_pointer_tracker_dump (void);
guint32 last_opid;
};
+/**
+ * e_operation_pool_new:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
EOperationPool *
e_operation_pool_new (guint max_threads,
GFunc thread_func,
return pool;
}
+/**
+ * e_operation_pool_free:
+ *
+ * FIXME: Document me.
+ *
+ * Since: 3.2
+ **/
void
e_operation_pool_free (EOperationPool *pool)
{
g_free (pool);
}
-/* Reserves new operation ID, which is returned. This operation ID may
- * be released by e_operation_pool_release_opid () when the operation
+/**
+ * e_operation_pool_reserve_opid:
+ * @pool: an #EOperationPool
+ *
+ * Reserves new operation ID, which is returned. This operation ID may
+ * be released by e_operation_pool_release_opid() when the operation
* is finished.
-*/
+ *
+ * Returns: a new operation ID
+ *
+ * Since: 3.2
+ **/
guint32
e_operation_pool_reserve_opid (EOperationPool *pool)
{
return opid;
}
-/* Releases operation ID previously reserved by e_operation_pool_reserve_opid(). */
+/**
+ * e_operation_pool_release_opid:
+ * @pool: an #EOperationPool
+ * @opid: an operation ID
+ *
+ * Releases @opid previously reserved by e_operation_pool_reserve_opid().
+ *
+ * Since: 3.2
+ **/
void
e_operation_pool_release_opid (EOperationPool *pool,
guint32 opid)
g_mutex_unlock (pool->ops_lock);
}
-/* Pushes operation to be processed. 'opdata' is passed to the function
- * provided in e_operation_pool_new ().
-*/
+/**
+ * e_operation_pool_push:
+ * @pool: an #EOperationPool
+ * @opdata: user data for the operation
+ *
+ * Pushes an operation to be processed. @opdata is passed to the function
+ * provided in e_operation_pool_new().
+ *
+ * Since: 3.2
+ **/
void
e_operation_pool_push (EOperationPool *pool,
gpointer opdata)
#include <gio/gio.h>
+/**
+ * EOperationPool:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
typedef struct _EOperationPool EOperationPool;
EOperationPool *e_operation_pool_new (guint max_threads, GFunc thread_func, gpointer user_data);
typedef struct _ECategoriesEditorClass ECategoriesEditorClass;
typedef struct _ECategoriesEditorPrivate ECategoriesEditorPrivate;
+/**
+ * ECategoriesEditor:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _ECategoriesEditor {
GtkTable parent;
ECategoriesEditorPrivate *priv;
typedef struct _ECategoriesSelectorClass ECategoriesSelectorClass;
typedef struct _ECategoriesSelectorPrivate ECategoriesSelectorPrivate;
+/**
+ * ECategoriesSelector:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _ECategoriesSelector {
GtkTreeView parent;
ECategoriesSelectorPrivate *priv;
typedef struct _ECategoryEditorClass ECategoryEditorClass;
typedef struct _ECategoryEditorPrivate ECategoryEditorPrivate;
+/**
+ * ECategoryEditor:
+ *
+ * Contains only private data that should be read and manipulated using the
+ * functions below.
+ *
+ * Since: 3.2
+ **/
struct _ECategoryEditor {
GtkDialog parent;
ECategoryEditorPrivate *priv;
* e_client_utils_new:
*
* Proxy function for e_book_client_utils_new() and e_cal_client_utils_new().
+ *
+ * Since: 3.2
**/
EClient *
e_client_utils_new (ESource *source,
* e_client_utils_new_from_uri:
*
* Proxy function for e_book_client_utils_new_from_uri() and e_cal_client_utils_new_from_uri().
+ *
+ * Since: 3.2
**/
EClient *
e_client_utils_new_from_uri (const gchar *uri,
* e_client_utils_new_system:
*
* Proxy function for e_book_client_utils_new_system() and e_cal_client_utils_new_system().
+ *
+ * Since: 3.2
**/
EClient *
e_client_utils_new_system (EClientSourceType source_type,
* e_client_utils_new_default:
*
* Proxy function for e_book_client_utils_new_default() and e_cal_client_utils_new_default().
+ *
+ * Since: 3.2
**/
EClient *
e_client_utils_new_default (EClientSourceType source_type,
* e_client_utils_set_default:
*
* Proxy function for e_book_client_utils_set_default() and e_book_client_utils_set_default().
+ *
+ * Since: 3.2
**/
gboolean
e_client_utils_set_default (EClient *client,
* e_client_utils_set_default_source:
*
* Proxy function for e_book_client_utils_set_default_source() and e_cal_client_utils_set_default_source().
+ *
+ * Since: 3.2
**/
gboolean
e_client_utils_set_default_source (ESource *source,
* e_client_utils_get_sources:
*
* Proxy function for e_book_client_utils_get_sources() and e_cal_client_utils_get_sources().
+ *
+ * Since: 3.2
**/
gboolean
e_client_utils_get_sources (ESourceList **sources,
return uri_str;
}
-/* This function is suitable as a handler for EClient::authenticate signal.
+/**
+ * e_client_utils_authenticate_handler:
+ *
+ * This function is suitable as a handler for EClient::authenticate signal.
* It takes care of all the password prompt and such and returns TRUE if
* credentials (password) were provided. Thus just connect it to that signal
* and it'll take care of everything else.
*
* gtk_window_parent is user_data passed into the callback. It can be a pointer
* to GtkWindow, used as a parent for a pasword prompt dialog.
-*/
+ *
+ * Since: 3.2
+ **/
gboolean
e_client_utils_authenticate_handler (EClient *client,
ECredentials *credentials,
g_free (prompt_key);
}
-/* Asks for a password based on the provided credentials information.
+/**
+ * e_credentials_authenticate_helper:
+ *
+ * Asks for a password based on the provided credentials information.
* Credentials should have set following keys:
* E_CREDENTIALS_KEY_USERNAME
* E_CREDENTIALS_KEY_PROMPT_KEY
*
* When this returns TRUE, then the structure contains E_CREDENTIALS_KEY_PASSWORD set
* as entered by a user.
-*/
+ *
+ * Since: 3.2
+ **/
gboolean
e_credentials_authenticate_helper (ECredentials *credentials,
GtkWindow *parent,
G_BEGIN_DECLS
+/**
+ * EClientSourceType:
+ *
+ * Since: 3.2
+ **/
typedef enum {
E_CLIENT_SOURCE_TYPE_CONTACTS,
E_CLIENT_SOURCE_TYPE_EVENTS,
E_CLIENT_SOURCE_TYPE_LAST
} EClientSourceType;
+/**
+ * EClientUtilsAuthenticateHandler:
+ *
+ * Since: 3.2
+ **/
typedef gboolean (* EClientUtilsAuthenticateHandler) (EClient *client, ECredentials *credentials, gpointer user_data);
EClient * e_client_utils_new (ESource *source, EClientSourceType source_type, GError **error);
* Gets the #EBookClient that provided the contact at @iter.
*
* Returns: An #EBookClient.
+ *
+ * Since: 3.2
**/
EBookClient *
e_contact_store_get_client (EContactStore *contact_store,
*
* Returns: A #GSList of pointers to #EBookClient. The caller owns the list,
* but not the book clients.
+ *
+ * Since: 3.2
**/
GSList *
e_contact_store_get_clients (EContactStore *contact_store)
*
* Adds @book_client to the list of book clients that provide contacts for @contact_store.
* The @contact_store adds a reference to @book_client, if added.
+ *
+ * Since: 3.2
**/
void
e_contact_store_add_client (EContactStore *contact_store,
* @book_client: an #EBookClient
*
* Removes @book from the list of book clients that provide contacts for @contact_store.
+ *
+ * Since: 3.2
**/
void
e_contact_store_remove_client (EContactStore *contact_store,