src/stash.h

   1 /*
   2  *        stash.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *        Copyright 2008-2010 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   5  *        Copyright 2008-2010 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   6  *
   7  *        This program is free software; you can redistribute it and/or modify
   8  *        it under the terms of the GNU General Public License as published by
   9  *        the Free Software Foundation; either version 2 of the License, or
  10  *        (at your option) any later version.
  11  *
  12  *        This program is distributed in the hope that it will be useful,
  13  *        but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *        GNU General Public License for more details.
  16  *
  17  *        You should have received a copy of the GNU General Public License
  18  *        along with this program; if not, write to the Free Software
  19  *        Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  *        MA 02110-1301, USA.
  21  *
  22  * $Id$
  23  */
  24
  25 #ifndef GEANY_STASH_H
  26 #define GEANY_STASH_H
  27
  28 /** Opaque type for a group of settings. */
  29 typedef struct StashGroup StashGroup;
  30
  31 /** Can be @c GtkWidget* or @c gchar* depending on whether the @a owner argument is used for
  32  * stash_group_display() and stash_group_update(). */
  33 typedef gpointer StashWidgetID;
  34
  35
  36 StashGroup *stash_group_new(const gchar *name);
  37
  38 void stash_group_set_write_once(StashGroup *group, gboolean write_once);
  39
  40 void stash_group_set_use_defaults(StashGroup *group, gboolean use_defaults);
  41
  42 void stash_group_add_boolean(StashGroup *group, gboolean *setting,
  43                 const gchar *key_name, gboolean default_value);
  44
  45 void stash_group_add_integer(StashGroup *group, gint *setting,
  46                 const gchar *key_name, gint default_value);
  47
  48 void stash_group_add_string(StashGroup *group, gchar **setting,
  49                 const gchar *key_name, const gchar *default_value);
  50
  51 void stash_group_add_string_vector(StashGroup *group, gchar ***setting,
  52                 const gchar *key_name, const gchar **default_value);
  53
  54 void stash_group_load_from_key_file(StashGroup *group, GKeyFile *keyfile);
  55
  56 void stash_group_save_to_key_file(StashGroup *group, GKeyFile *keyfile);
  57
  58 gboolean stash_group_load_from_file(StashGroup *group, const gchar *filename);
  59
  60 gint stash_group_save_to_file(StashGroup *group, const gchar *filename,
  61                 GKeyFileFlags flags);
  62
  63 void stash_group_free(StashGroup *group);
  64
  65
  66 /* *** GTK-related functions *** */
  67
  68 void stash_group_add_toggle_button(StashGroup *group, gboolean *setting,
  69                 const gchar *key_name, gboolean default_value, StashWidgetID widget_id);
  70
  71 void stash_group_add_radio_buttons(StashGroup *group, gint *setting,
  72                 const gchar *key_name, gint default_value,
  73                 StashWidgetID widget_id, gint enum_id, ...) G_GNUC_NULL_TERMINATED;
  74
  75 void stash_group_add_spin_button_integer(StashGroup *group, gint *setting,
  76                 const gchar *key_name, gint default_value, StashWidgetID widget_id);
  77
  78 void stash_group_add_combo_box(StashGroup *group, gint *setting,
  79                 const gchar *key_name, gint default_value, StashWidgetID widget_id);
  80
  81 void stash_group_add_combo_box_entry(StashGroup *group, gchar **setting,
  82                 const gchar *key_name, const gchar *default_value, StashWidgetID widget_id);
  83
  84 void stash_group_add_entry(StashGroup *group, gchar **setting,
  85                 const gchar *key_name, const gchar *default_value, StashWidgetID widget_id);
  86
  87 void stash_group_add_widget_property(StashGroup *group, gpointer setting,
  88                 const gchar *key_name, gpointer default_value, StashWidgetID widget_id,
  89                 const gchar *property_name, GType type);
  90
  91 void stash_group_display(StashGroup *group, GtkWidget *owner);
  92
  93 void stash_group_update(StashGroup *group, GtkWidget *owner);
  94
  95 #endif