libedataserver/e-source-backend.h

   1 /*
   2  * e-source-backend.h
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) version 3.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with the program; if not, see <http://www.gnu.org/licenses/>
  16  *
  17  */
  18
  19 #ifndef E_SOURCE_BACKEND_H
  20 #define E_SOURCE_BACKEND_H
  21
  22 #include <libedataserver/e-source-extension.h>
  23
  24 /* Standard GObject macros */
  25 #define E_TYPE_SOURCE_BACKEND \
  26         (e_source_backend_get_type ())
  27 #define E_SOURCE_BACKEND(obj) \
  28         (G_TYPE_CHECK_INSTANCE_CAST \
  29         ((obj), E_TYPE_SOURCE_BACKEND, ESourceBackend))
  30 #define E_SOURCE_BACKEND_CLASS(cls) \
  31         (G_TYPE_CHECK_CLASS_CAST \
  32         ((cls), E_TYPE_SOURCE_BACKEND, ESourceBackendClass))
  33 #define E_IS_SOURCE_BACKEND(obj) \
  34         (G_TYPE_CHECK_INSTANCE_TYPE \
  35         ((obj), E_TYPE_SOURCE_BACKEND))
  36 #define E_IS_SOURCE_BACKEND_CLASS(cls) \
  37         (G_TYPE_CHECK_CLASS_TYPE \
  38         ((cls), E_TYPE_SOURCE_BACKEND))
  39 #define E_SOURCE_BACKEND_GET_CLASS(obj) \
  40         (G_TYPE_INSTANCE_GET_CLASS \
  41         ((obj), E_TYPE_SOURCE_BACKEND, ESourceBackendClass))
  42
  43 G_BEGIN_DECLS
  44
  45 typedef struct _ESourceBackend ESourceBackend;
  46 typedef struct _ESourceBackendClass ESourceBackendClass;
  47 typedef struct _ESourceBackendPrivate ESourceBackendPrivate;
  48
  49 /**
  50  * ESourceBackend:
  51  *
  52  * Contains only private data that should be read and manipulated using the
  53  * functions below.
  54  *
  55  * Since: 3.6
  56  **/
  57 struct _ESourceBackend {
  58         ESourceExtension parent;
  59         ESourceBackendPrivate *priv;
  60 };
  61
  62 struct _ESourceBackendClass {
  63         ESourceExtensionClass parent_class;
  64 };
  65
  66 GType           e_source_backend_get_type       (void) G_GNUC_CONST;
  67 const gchar *   e_source_backend_get_backend_name
  68                                                 (ESourceBackend *extension);
  69 gchar *         e_source_backend_dup_backend_name
  70                                                 (ESourceBackend *extension);
  71 void            e_source_backend_set_backend_name
  72                                                 (ESourceBackend *extension,
  73                                                  const gchar *backend_name);
  74
  75 G_END_DECLS
  76
  77 #endif /* E_SOURCE_BACKEND_H */