src/stash.h

   1 /*
   2  *      stash.h - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2008-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   5  *      Copyright 2008-2012 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 along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef GEANY_STASH_H
  23 #define GEANY_STASH_H 1
  24
  25 #include "gtkcompat.h"
  26
  27 G_BEGIN_DECLS
  28
  29 /** Opaque type for a group of settings. */
  30 typedef struct StashGroup StashGroup;
  31
  32 /** Can be @c GtkWidget* or @c gchar* depending on whether the @a owner argument is used for
  33  * stash_group_display() and stash_group_update(). */
  34 typedef gconstpointer StashWidgetID;
  35
  36
  37 StashGroup *stash_group_new(const gchar *name);
  38
  39 void stash_group_add_boolean(StashGroup *group, gboolean *setting,
  40                 const gchar *key_name, gboolean default_value);
  41
  42 void stash_group_add_integer(StashGroup *group, gint *setting,
  43                 const gchar *key_name, gint default_value);
  44
  45 void stash_group_add_string(StashGroup *group, gchar **setting,
  46                 const gchar *key_name, const gchar *default_value);
  47
  48 void stash_group_add_string_vector(StashGroup *group, gchar ***setting,
  49                 const gchar *key_name, const gchar **default_value);
  50
  51 void stash_group_load_from_key_file(StashGroup *group, GKeyFile *keyfile);
  52
  53 void stash_group_save_to_key_file(StashGroup *group, GKeyFile *keyfile);
  54
  55 void stash_group_free(StashGroup *group);
  56
  57 gboolean stash_group_load_from_file(StashGroup *group, const gchar *filename);
  58
  59 gint stash_group_save_to_file(StashGroup *group, const gchar *filename,
  60                 GKeyFileFlags flags);
  61
  62 /* *** GTK-related functions *** */
  63
  64 void stash_group_add_toggle_button(StashGroup *group, gboolean *setting,
  65                 const gchar *key_name, gboolean default_value, StashWidgetID widget_id);
  66
  67 void stash_group_add_radio_buttons(StashGroup *group, gint *setting,
  68                 const gchar *key_name, gint default_value,
  69                 StashWidgetID widget_id, gint enum_id, ...) G_GNUC_NULL_TERMINATED;
  70
  71 void stash_group_add_spin_button_integer(StashGroup *group, gint *setting,
  72                 const gchar *key_name, gint default_value, StashWidgetID widget_id);
  73
  74 void stash_group_add_combo_box(StashGroup *group, gint *setting,
  75                 const gchar *key_name, gint default_value, StashWidgetID widget_id);
  76
  77 void stash_group_add_combo_box_entry(StashGroup *group, gchar **setting,
  78                 const gchar *key_name, const gchar *default_value, StashWidgetID widget_id);
  79
  80 void stash_group_add_entry(StashGroup *group, gchar **setting,
  81                 const gchar *key_name, const gchar *default_value, StashWidgetID widget_id);
  82
  83 void stash_group_add_widget_property(StashGroup *group, gpointer setting,
  84                 const gchar *key_name, gpointer default_value, StashWidgetID widget_id,
  85                 const gchar *property_name, GType type);
  86
  87 void stash_group_display(StashGroup *group, GtkWidget *owner);
  88
  89 void stash_group_update(StashGroup *group, GtkWidget *owner);
  90
  91 void stash_group_free_settings(StashGroup *group);
  92
  93
  94 #ifdef GEANY_PRIVATE
  95
  96 void stash_group_set_various(StashGroup *group, gboolean write_once);
  97
  98 void stash_group_set_use_defaults(StashGroup *group, gboolean use_defaults);
  99
 100 /* *** GTK-related functions *** */
 101
 102 void stash_tree_setup(GPtrArray *group_array, GtkTreeView *tree);
 103
 104 void stash_tree_display(GtkTreeView *tree);
 105
 106 void stash_tree_update(GtkTreeView *tree);
 107
 108 #endif /* GEANY_PRIVATE */
 109
 110 G_END_DECLS
 111
 112 #endif /* GEANY_STASH_H */