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 GType stash_group_get_type(void);
  37
  38 StashGroup *stash_group_new(const gchar *name);
  39
  40 void stash_group_add_boolean(StashGroup *group, gboolean *setting,
  41                 const gchar *key_name, gboolean default_value);
  42
  43 void stash_group_add_integer(StashGroup *group, gint *setting,
  44                 const gchar *key_name, gint default_value);
  45
  46 void stash_group_add_string(StashGroup *group, gchar **setting,
  47                 const gchar *key_name, const gchar *default_value);
  48
  49 void stash_group_add_string_vector(StashGroup *group, gchar ***setting,
  50                 const gchar *key_name, const gchar **default_value);
  51
  52 void stash_group_load_from_key_file(StashGroup *group, GKeyFile *keyfile);
  53
  54 void stash_group_save_to_key_file(StashGroup *group, GKeyFile *keyfile);
  55
  56 void stash_group_free(StashGroup *group);
  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 /* *** GTK-related functions *** */
  64
  65 void stash_group_add_toggle_button(StashGroup *group, gboolean *setting,
  66                 const gchar *key_name, gboolean default_value, StashWidgetID widget_id);
  67
  68 void stash_group_add_radio_buttons(StashGroup *group, gint *setting,
  69                 const gchar *key_name, gint default_value,
  70                 StashWidgetID widget_id, gint enum_id, ...) G_GNUC_NULL_TERMINATED;
  71
  72 void stash_group_add_spin_button_integer(StashGroup *group, gint *setting,
  73                 const gchar *key_name, gint default_value, StashWidgetID widget_id);
  74
  75 void stash_group_add_combo_box(StashGroup *group, gint *setting,
  76                 const gchar *key_name, gint default_value, StashWidgetID widget_id);
  77
  78 void stash_group_add_combo_box_entry(StashGroup *group, gchar **setting,
  79                 const gchar *key_name, const gchar *default_value, StashWidgetID widget_id);
  80
  81 void stash_group_add_entry(StashGroup *group, gchar **setting,
  82                 const gchar *key_name, const gchar *default_value, StashWidgetID widget_id);
  83
  84 void stash_group_add_widget_property(StashGroup *group, gpointer setting,
  85                 const gchar *key_name, gpointer default_value, StashWidgetID widget_id,
  86                 const gchar *property_name, GType type);
  87
  88 void stash_group_display(StashGroup *group, GtkWidget *owner);
  89
  90 void stash_group_update(StashGroup *group, GtkWidget *owner);
  91
  92 void stash_group_free_settings(StashGroup *group);
  93
  94
  95 #ifdef GEANY_PRIVATE
  96
  97 void stash_group_set_various(StashGroup *group, gboolean write_once);
  98
  99 void stash_group_set_use_defaults(StashGroup *group, gboolean use_defaults);
 100
 101 /* *** GTK-related functions *** */
 102
 103 void stash_tree_setup(GPtrArray *group_array, GtkTreeView *tree);
 104
 105 void stash_tree_display(GtkTreeView *tree);
 106
 107 void stash_tree_update(GtkTreeView *tree);
 108
 109 #endif /* GEANY_PRIVATE */
 110
 111 G_END_DECLS
 112
 113 #endif /* GEANY_STASH_H */