LibreOffice Module connectivity (master) 1
Classes | Macros | Typedefs | Enumerations | Functions | Variables
EApi.h File Reference
#include <glib-object.h>
Include dependency graph for EApi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  EContactAddress
 

Macros

#define EAPI_EXTERN   extern
 
#define E_CONTACT(a)   ((EContact *)(a))
 
#define E_TYPE_CONTACT   (e_contact_get_type())
 
#define E_SOURCE(a)   ((ESource *)(a))
 
#define E_SOURCE_GROUP(a)   ((ESourceGroup *)(a))
 
#define E_SOURCE_EXTENSION_ADDRESS_BOOK   "Address Book"
 

Typedefs

typedef void EContact
 
typedef int EContactField
 
typedef void ESource
 
typedef void ESourceList
 
typedef void ESourceGroup
 
typedef void EBook
 
typedef void EBookQuery
 
typedef void ESourceRegistry
 
typedef void GCancellable
 
typedef void ESourceBackend
 
typedef void EClient
 
typedef EClient EBookClient
 

Enumerations

enum  EBookQueryTest {
  E_BOOK_QUERY_IS ,
  E_BOOK_QUERY_CONTAINS ,
  E_BOOK_QUERY_BEGINS_WITH ,
  E_BOOK_QUERY_ENDS_WITH
}
 

Functions

bool EApiInit ()
 
ESourceRegistryget_e_source_registry ()
 
bool isSourceBackend (ESource *pSource, const char *backendname)
 

Variables

EAPI_EXTERN const char *(* e_contact_field_name )(EContactField field_id)
 
EAPI_EXTERN gpointer(* e_contact_get )(EContact *contact, EContactField field_id)
 
EAPI_EXTERN gconstpointer(* e_contact_get_const )(EContact *contact, EContactField field_id)
 
EAPI_EXTERN const char *(* e_source_peek_name )(ESource *source)
 
EAPI_EXTERN const gchar *(* e_source_get_property )(ESource *source, const gchar *property)
 
EAPI_EXTERN GType(* e_contact_get_type )(void)
 
EAPI_EXTERN EContactField(* e_contact_field_id )(const char *field_name)
 
EAPI_EXTERN GSList *(* e_source_list_peek_groups )(ESourceList *list)
 
EAPI_EXTERN GSList *(* e_source_group_peek_sources )(ESourceGroup *group)
 
EAPI_EXTERN const char *(* e_source_group_peek_base_uri )(ESourceGroup *group)
 
EAPI_EXTERN EBook *(* e_book_new )(ESource *source, GError **error)
 
EAPI_EXTERN gboolean(* e_book_open )(EBook *book, gboolean only_if_exists, GError **error)
 
EAPI_EXTERN const char *(* e_book_get_uri )(EBook *book)
 
EAPI_EXTERN ESource *(* e_book_get_source )(EBook *book)
 
EAPI_EXTERN gboolean(* e_book_get_addressbooks )(ESourceList **addressbook_sources, GError **error)
 
EAPI_EXTERN gboolean(* e_book_get_contacts )(EBook *book, EBookQuery *query, GList **contacts, GError **error)
 
EAPI_EXTERN gboolean(* e_book_authenticate_user )(EBook *book, const char *user, const char *passwd, const char *auth_method, GError **error)
 
EAPI_EXTERN EBookQuery *(* e_book_query_field_exists )(EContactField field)
 
EAPI_EXTERN EBookQuery *(* e_book_query_field_test )(EContactField field, EBookQueryTest test, const char *value)
 
EAPI_EXTERN EBookQuery *(* e_book_query_and )(int nqs, EBookQuery **qs, gboolean unref)
 
EAPI_EXTERN EBookQuery *(* e_book_query_or )(int nqs, EBookQuery **qs, gboolean unref)
 
EAPI_EXTERN EBookQuery *(* e_book_query_not )(EBookQuery *q, gboolean unref)
 
EAPI_EXTERN EBookQuery *(* e_book_query_ref )(EBookQuery *q)
 
EAPI_EXTERN void(* e_book_query_unref )(EBookQuery *q)
 
EAPI_EXTERN char *(* e_book_query_to_string )(EBookQuery *q)
 
EAPI_EXTERN EBookQuery *(* e_book_query_from_string )(const char *query_string)
 
EAPI_EXTERN ESourceRegistry *(* e_source_registry_new_sync )(GCancellable *cancellable, GError **error)
 
EAPI_EXTERN GList *(* e_source_registry_list_sources )(ESourceRegistry *registry, const gchar *extension_name)
 
EAPI_EXTERN gboolean(* e_source_has_extension )(ESource *source, const gchar *extension_name)
 
EAPI_EXTERN gpointer(* e_source_get_extension )(ESource *source, const gchar *extension_name)
 
EAPI_EXTERN const gchar *(* e_source_backend_get_backend_name )(ESourceBackend *extension)
 
EAPI_EXTERN const gchar *(* e_source_get_display_name )(ESource *source)
 
EAPI_EXTERN const gchar *(* eds_check_version )(guint required_major, guint required_minor, guint required_micro)
 
EAPI_EXTERN const gchar *(* e_source_get_uid )(ESource *source)
 
EAPI_EXTERN ESource *(* e_source_registry_ref_source )(ESourceRegistry *registry, const gchar *uid)
 
EAPI_EXTERN EBookClient *(* e_book_client_new )(ESource *source, GError **error)
 
EAPI_EXTERN EBookClient *(* e_book_client_connect_direct_sync )(ESourceRegistry *registry, ESource *source, guint32 wait_for_connected_seconds, GCancellable *cancellable, GError **error)
 
EAPI_EXTERN gboolean(* e_client_open_sync )(EClient *client, gboolean only_if_exists, GCancellable *cancellable, GError **error)
 
EAPI_EXTERN ESource *(* e_client_get_source )(EClient *client)
 
EAPI_EXTERN gboolean(* e_book_client_get_contacts_sync )(EBookClient *client, const gchar *sexp, GSList **contacts, GCancellable *cancellable, GError **error)
 
EAPI_EXTERN void(* e_client_util_free_object_slist )(GSList *objects)
 

Macro Definition Documentation

◆ E_CONTACT

#define E_CONTACT (   a)    ((EContact *)(a))

Definition at line 45 of file EApi.h.

◆ E_SOURCE

#define E_SOURCE (   a)    ((ESource *)(a))

Definition at line 54 of file EApi.h.

◆ E_SOURCE_EXTENSION_ADDRESS_BOOK

#define E_SOURCE_EXTENSION_ADDRESS_BOOK   "Address Book"

Definition at line 133 of file EApi.h.

◆ E_SOURCE_GROUP

#define E_SOURCE_GROUP (   a)    ((ESourceGroup *)(a))

Definition at line 68 of file EApi.h.

◆ E_TYPE_CONTACT

#define E_TYPE_CONTACT   (e_contact_get_type())

Definition at line 46 of file EApi.h.

◆ EAPI_EXTERN

#define EAPI_EXTERN   extern

Definition at line 40 of file EApi.h.

Typedef Documentation

◆ EBook

typedef void EBook

Definition at line 80 of file EApi.h.

◆ EBookClient

Definition at line 138 of file EApi.h.

◆ EBookQuery

typedef void EBookQuery

Definition at line 81 of file EApi.h.

◆ EClient

typedef void EClient

Definition at line 137 of file EApi.h.

◆ EContact

typedef void EContact

Definition at line 44 of file EApi.h.

◆ EContactField

typedef int EContactField

Definition at line 47 of file EApi.h.

◆ ESource

typedef void ESource

Definition at line 53 of file EApi.h.

◆ ESourceBackend

typedef void ESourceBackend

Definition at line 136 of file EApi.h.

◆ ESourceGroup

typedef void ESourceGroup

Definition at line 67 of file EApi.h.

◆ ESourceList

typedef void ESourceList

Definition at line 63 of file EApi.h.

◆ ESourceRegistry

typedef void ESourceRegistry

Definition at line 134 of file EApi.h.

◆ GCancellable

typedef void GCancellable

Definition at line 135 of file EApi.h.

Enumeration Type Documentation

◆ EBookQueryTest

Enumerator
E_BOOK_QUERY_IS 
E_BOOK_QUERY_CONTAINS 
E_BOOK_QUERY_BEGINS_WITH 
E_BOOK_QUERY_ENDS_WITH 

Definition at line 73 of file EApi.h.

Function Documentation

◆ EApiInit()

bool EApiInit ( )

◆ get_e_source_registry()

ESourceRegistry * get_e_source_registry ( )

◆ isSourceBackend()

bool isSourceBackend ( ESource pSource,
const char *  backendname 
)

Variable Documentation

◆ e_book_authenticate_user

EAPI_EXTERN gboolean(* e_book_authenticate_user) (EBook *book, const char *user, const char *passwd, const char *auth_method, GError **error) ( EBook book,
const char *  user,
const char *  passwd,
const char *  auth_method,
GError **  error 
)

Definition at line 101 of file EApi.h.

◆ e_book_client_connect_direct_sync

EAPI_EXTERN EBookClient *(* e_book_client_connect_direct_sync) (ESourceRegistry *registry, ESource *source, guint32 wait_for_connected_seconds, GCancellable *cancellable, GError **error) ( ESourceRegistry registry,
ESource source,
guint32  wait_for_connected_seconds,
GCancellable cancellable,
GError **  error 
)

Definition at line 149 of file EApi.h.

◆ e_book_client_get_contacts_sync

EAPI_EXTERN gboolean(* e_book_client_get_contacts_sync) (EBookClient *client, const gchar *sexp, GSList **contacts, GCancellable *cancellable, GError **error) ( EBookClient client,
const gchar *  sexp,
GSList **  contacts,
GCancellable cancellable,
GError **  error 
)

Definition at line 152 of file EApi.h.

◆ e_book_client_new

EAPI_EXTERN EBookClient *(* e_book_client_new) (ESource *source, GError **error) ( ESource source,
GError **  error 
)

Definition at line 148 of file EApi.h.

◆ e_book_get_addressbooks

EAPI_EXTERN gboolean(* e_book_get_addressbooks) (ESourceList **addressbook_sources, GError **error) ( ESourceList **  addressbook_sources,
GError **  error 
)

Definition at line 93 of file EApi.h.

◆ e_book_get_contacts

EAPI_EXTERN gboolean(* e_book_get_contacts) (EBook *book, EBookQuery *query, GList **contacts, GError **error) ( EBook book,
EBookQuery query,
GList **  contacts,
GError **  error 
)

Definition at line 96 of file EApi.h.

◆ e_book_get_source

EAPI_EXTERN ESource *(* e_book_get_source) (EBook *book) ( EBook book)

Definition at line 91 of file EApi.h.

Referenced by connectivity::evoab::OEvoabVersionHelper::getUserName().

◆ e_book_get_uri

EAPI_EXTERN const char *(* e_book_get_uri) (EBook *book) ( EBook book)

Definition at line 90 of file EApi.h.

◆ e_book_new

EAPI_EXTERN EBook *(* e_book_new) (ESource *source, GError **error) ( ESource source,
GError **  error 
)

Definition at line 83 of file EApi.h.

◆ e_book_open

EAPI_EXTERN gboolean(* e_book_open) (EBook *book, gboolean only_if_exists, GError **error) ( EBook book,
gboolean  only_if_exists,
GError **  error 
)

Definition at line 86 of file EApi.h.

◆ e_book_query_and

EAPI_EXTERN EBookQuery *(* e_book_query_and) (int nqs, EBookQuery **qs, gboolean unref) ( int  nqs,
EBookQuery **  qs,
gboolean  unref 
)

Definition at line 112 of file EApi.h.

Referenced by connectivity::evoab::OCommonStatement::whereAnalysis().

◆ e_book_query_field_exists

EAPI_EXTERN EBookQuery *(* e_book_query_field_exists) (EContactField field) ( EContactField  field)

Definition at line 108 of file EApi.h.

◆ e_book_query_field_test

EAPI_EXTERN EBookQuery *(* e_book_query_field_test) (EContactField field, EBookQueryTest test, const char *value) ( EContactField  field,
EBookQueryTest  test,
const char *  value 
)

Definition at line 109 of file EApi.h.

◆ e_book_query_from_string

EAPI_EXTERN EBookQuery *(* e_book_query_from_string) (const char *query_string) ( const char *  query_string)

Definition at line 118 of file EApi.h.

◆ e_book_query_not

EAPI_EXTERN EBookQuery *(* e_book_query_not) (EBookQuery *q, gboolean unref) ( EBookQuery q,
gboolean  unref 
)

Definition at line 114 of file EApi.h.

Referenced by connectivity::evoab::OCommonStatement::whereAnalysis().

◆ e_book_query_or

EAPI_EXTERN EBookQuery *(* e_book_query_or) (int nqs, EBookQuery **qs, gboolean unref) ( int  nqs,
EBookQuery **  qs,
gboolean  unref 
)

Definition at line 113 of file EApi.h.

Referenced by connectivity::evoab::OCommonStatement::whereAnalysis().

◆ e_book_query_ref

EAPI_EXTERN EBookQuery *(* e_book_query_ref) (EBookQuery *q) ( EBookQuery q)

◆ e_book_query_to_string

EAPI_EXTERN char *(* e_book_query_to_string) (EBookQuery *q) ( EBookQuery q)

◆ e_book_query_unref

EAPI_EXTERN void(* e_book_query_unref) (EBookQuery *q) ( EBookQuery q)

◆ e_client_get_source

EAPI_EXTERN ESource *(* e_client_get_source) (EClient *client) ( EClient client)

Definition at line 151 of file EApi.h.

◆ e_client_open_sync

EAPI_EXTERN gboolean(* e_client_open_sync) (EClient *client, gboolean only_if_exists, GCancellable *cancellable, GError **error) ( EClient client,
gboolean  only_if_exists,
GCancellable cancellable,
GError **  error 
)

Definition at line 150 of file EApi.h.

◆ e_client_util_free_object_slist

EAPI_EXTERN void(* e_client_util_free_object_slist) (GSList *objects) ( GSList *  objects)

Definition at line 153 of file EApi.h.

◆ e_contact_field_id

EAPI_EXTERN EContactField(* e_contact_field_id) (const char *field_name) ( const char *  field_name)

Definition at line 60 of file EApi.h.

Referenced by connectivity::evoab::whichAddress().

◆ e_contact_field_name

EAPI_EXTERN const char *(* e_contact_field_name) (EContactField field_id) ( EContactField  field_id)

Definition at line 49 of file EApi.h.

◆ e_contact_get

EAPI_EXTERN gpointer(* e_contact_get) (EContact *contact, EContactField field_id) ( EContact contact,
EContactField  field_id 
)

◆ e_contact_get_const

EAPI_EXTERN gconstpointer(* e_contact_get_const) (EContact *contact, EContactField field_id) ( EContact contact,
EContactField  field_id 
)

Definition at line 51 of file EApi.h.

◆ e_contact_get_type

EAPI_EXTERN GType(* e_contact_get_type) (void) ( void  )

Definition at line 59 of file EApi.h.

◆ e_source_backend_get_backend_name

EAPI_EXTERN const gchar *(* e_source_backend_get_backend_name) (ESourceBackend *extension) ( ESourceBackend extension)

Definition at line 143 of file EApi.h.

Referenced by isSourceBackend().

◆ e_source_get_display_name

EAPI_EXTERN const gchar *(* e_source_get_display_name) (ESource *source) ( ESource source)

Definition at line 144 of file EApi.h.

Referenced by connectivity::evoab::OEvoabDatabaseMetaData::getTables().

◆ e_source_get_extension

EAPI_EXTERN gpointer(* e_source_get_extension) (ESource *source, const gchar *extension_name) ( ESource source,
const gchar *  extension_name 
)

Definition at line 142 of file EApi.h.

Referenced by isSourceBackend().

◆ e_source_get_property

EAPI_EXTERN const gchar *(* e_source_get_property) (ESource *source, const gchar *property) ( ESource source,
const gchar *  property 
)

Definition at line 56 of file EApi.h.

Referenced by connectivity::evoab::OEvoabVersionHelper::getUserName().

◆ e_source_get_uid

EAPI_EXTERN const gchar *(* e_source_get_uid) (ESource *source) ( ESource source)

Definition at line 146 of file EApi.h.

Referenced by connectivity::evoab::OEvoabDatabaseMetaData::getTables().

◆ e_source_group_peek_base_uri

EAPI_EXTERN const char *(* e_source_group_peek_base_uri) (ESourceGroup *group) ( ESourceGroup group)

Definition at line 71 of file EApi.h.

◆ e_source_group_peek_sources

EAPI_EXTERN GSList *(* e_source_group_peek_sources) (ESourceGroup *group) ( ESourceGroup group)

Definition at line 70 of file EApi.h.

◆ e_source_has_extension

EAPI_EXTERN gboolean(* e_source_has_extension) (ESource *source, const gchar *extension_name) ( ESource source,
const gchar *  extension_name 
)

Definition at line 141 of file EApi.h.

Referenced by isSourceBackend().

◆ e_source_list_peek_groups

EAPI_EXTERN GSList *(* e_source_list_peek_groups) (ESourceList *list) ( ESourceList list)

Definition at line 64 of file EApi.h.

◆ e_source_peek_name

EAPI_EXTERN const char *(* e_source_peek_name) (ESource *source) ( ESource source)

Definition at line 55 of file EApi.h.

◆ e_source_registry_list_sources

EAPI_EXTERN GList *(* e_source_registry_list_sources) (ESourceRegistry *registry, const gchar *extension_name) ( ESourceRegistry registry,
const gchar *  extension_name 
)

Definition at line 140 of file EApi.h.

Referenced by connectivity::evoab::OEvoabDatabaseMetaData::getTables().

◆ e_source_registry_new_sync

EAPI_EXTERN ESourceRegistry *(* e_source_registry_new_sync) (GCancellable *cancellable, GError **error) ( GCancellable cancellable,
GError **  error 
)

Definition at line 139 of file EApi.h.

Referenced by get_e_source_registry().

◆ e_source_registry_ref_source

EAPI_EXTERN ESource *(* e_source_registry_ref_source) (ESourceRegistry *registry, const gchar *uid) ( ESourceRegistry registry,
const gchar *  uid 
)

Definition at line 147 of file EApi.h.

◆ eds_check_version

EAPI_EXTERN const gchar *(* eds_check_version) (guint required_major, guint required_minor, guint required_micro) ( guint  required_major,
guint  required_minor,
guint  required_micro 
)

Definition at line 145 of file EApi.h.