service/dconf-writer.h

   1 /*
   2  * Copyright © 2010 Codethink Limited
   3  *
   4  * This library 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 licence, or (at your option) any later version.
   8  *
   9  * This library 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 this library; if not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Author: Ryan Lortie <desrt@desrt.ca>
  18  */
  19
  20 #ifndef __dconf_writer_h__
  21 #define __dconf_writer_h__
  22
  23 #include <glib.h>
  24 #include <gio/gio.h>
  25 #include <gobject/gobject.h>
  26
  27 #include "../common/dconf-changeset.h"
  28 #include "dconf-generated.h"
  29
  30 #define DCONF_TYPE_WRITER                                   (dconf_writer_get_type ())
  31 #define DCONF_WRITER(inst)                                  (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  32                                                              DCONF_TYPE_WRITER, DConfWriter))
  33 #define DCONF_WRITER_CLASS(class)                           (G_TYPE_CHECK_CLASS_CAST ((class),                       \
  34                                                              DCONF_TYPE_WRITER, DConfWriterClass))
  35 #define DCONF_IS_WRITER(inst)                               (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
  36                                                              DCONF_TYPE_WRITER))
  37 #define DCONF_IS_WRITER_CLASS(class)                        (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
  38                                                              DCONF_TYPE_WRITER))
  39 #define DCONF_WRITER_GET_CLASS(inst)                        (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
  40                                                              DCONF_TYPE_WRITER, DConfWriterClass))
  41
  42 typedef struct _DConfWriterPrivate                          DConfWriterPrivate;
  43 typedef struct _DConfWriterClass                            DConfWriterClass;
  44 typedef struct _DConfWriter                                 DConfWriter;
  45
  46 struct _DConfWriterClass
  47 {
  48   DConfDBusWriterSkeletonClass parent_instance;
  49
  50   /* static methods */
  51   void     (* list)   (GHashTable      *set);
  52
  53   /* instance methods */
  54   gboolean (* begin)  (DConfWriter     *writer,
  55                        GError         **error);
  56   void     (* change) (DConfWriter     *writer,
  57                        DConfChangeset  *changeset,
  58                        const gchar     *tag);
  59   gboolean (* commit) (DConfWriter     *writer,
  60                        GError         **error);
  61   void     (* end)    (DConfWriter     *writer);
  62 };
  63
  64 struct _DConfWriter
  65 {
  66   DConfDBusWriterSkeleton parent_instance;
  67   DConfWriterPrivate *priv;
  68 };
  69
  70 G_DEFINE_AUTOPTR_CLEANUP_FUNC (DConfWriter, g_object_unref)
  71
  72 GType                   dconf_writer_get_type                           (void);
  73
  74 void                    dconf_writer_set_basepath                       (DConfWriter *writer,
  75                                                                          const gchar *name);
  76 DConfChangeset *        dconf_writer_diff                               (DConfWriter *writer,
  77                                                                          DConfChangeset *changeset);
  78 const gchar *           dconf_writer_get_name                           (DConfWriter *writer);
  79
  80 void                    dconf_writer_list                               (GType        type,
  81                                                                          GHashTable  *set);
  82 GDBusInterfaceSkeleton *dconf_writer_new                                (GType        type,
  83                                                                          const gchar *name);
  84
  85 #define DCONF_TYPE_SHM_WRITER                               (dconf_shm_writer_get_type ())
  86 GType                   dconf_shm_writer_get_type                       (void);
  87 #define DCONF_TYPE_KEYFILE_WRITER                           (dconf_keyfile_writer_get_type ())
  88 GType                   dconf_keyfile_writer_get_type                   (void);
  89
  90 #endif /* __dconf_writer_h__ */