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 #if !defined (__LIBEDATASERVER_H_INSIDE__) && !defined (LIBEDATASERVER_COMPILATION)
  20 #error "Only <libedataserver/libedataserver.h> should be included directly."
  21 #endif
  22
  23 #ifndef E_SOURCE_BACKEND_H
  24 #define E_SOURCE_BACKEND_H
  25
  26 #include <libedataserver/e-source-extension.h>
  27
  28 /* Standard GObject macros */
  29 #define E_TYPE_SOURCE_BACKEND \
  30         (e_source_backend_get_type ())
  31 #define E_SOURCE_BACKEND(obj) \
  32         (G_TYPE_CHECK_INSTANCE_CAST \
  33         ((obj), E_TYPE_SOURCE_BACKEND, ESourceBackend))
  34 #define E_SOURCE_BACKEND_CLASS(cls) \
  35         (G_TYPE_CHECK_CLASS_CAST \
  36         ((cls), E_TYPE_SOURCE_BACKEND, ESourceBackendClass))
  37 #define E_IS_SOURCE_BACKEND(obj) \
  38         (G_TYPE_CHECK_INSTANCE_TYPE \
  39         ((obj), E_TYPE_SOURCE_BACKEND))
  40 #define E_IS_SOURCE_BACKEND_CLASS(cls) \
  41         (G_TYPE_CHECK_CLASS_TYPE \
  42         ((cls), E_TYPE_SOURCE_BACKEND))
  43 #define E_SOURCE_BACKEND_GET_CLASS(obj) \
  44         (G_TYPE_INSTANCE_GET_CLASS \
  45         ((obj), E_TYPE_SOURCE_BACKEND, ESourceBackendClass))
  46
  47 G_BEGIN_DECLS
  48
  49 typedef struct _ESourceBackend ESourceBackend;
  50 typedef struct _ESourceBackendClass ESourceBackendClass;
  51 typedef struct _ESourceBackendPrivate ESourceBackendPrivate;
  52
  53 /**
  54  * ESourceBackend:
  55  *
  56  * Contains only private data that should be read and manipulated using the
  57  * functions below.
  58  *
  59  * Since: 3.6
  60  **/
  61 struct _ESourceBackend {
  62         ESourceExtension parent;
  63         ESourceBackendPrivate *priv;
  64 };
  65
  66 struct _ESourceBackendClass {
  67         ESourceExtensionClass parent_class;
  68 };
  69
  70 GType           e_source_backend_get_type       (void) G_GNUC_CONST;
  71 const gchar *   e_source_backend_get_backend_name
  72                                                 (ESourceBackend *extension);
  73 gchar *         e_source_backend_dup_backend_name
  74                                                 (ESourceBackend *extension);
  75 void            e_source_backend_set_backend_name
  76                                                 (ESourceBackend *extension,
  77                                                  const gchar *backend_name);
  78
  79 G_END_DECLS
  80
  81 #endif /* E_SOURCE_BACKEND_H */