libedataserver/e-source-backend.h

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