AnjutaPreferences

AnjutaPreferences — Anjuta Preferences system.

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <libanjuta/anjuta-preferences.h>

GtkWidget *         anjuta_property_get_widget          (AnjutaProperty *prop);
struct              AnjutaPreferences;
struct              AnjutaPreferencesClass;
gboolean            (*AnjutaPreferencesCallback)        (AnjutaPreferences *pr,
                                                         const gchar *key,
                                                         gpointer data);
AnjutaPreferences * anjuta_preferences_new              (AnjutaPluginManager *plugin_manager,
                                                         const gchar *common_schema_id);
AnjutaPreferences * anjuta_preferences_default          (void);
void                anjuta_preferences_add_from_builder (AnjutaPreferences *pr,
                                                         GtkBuilder *builder,
                                                         GSettings *settings,
                                                         const gchar *glade_widget_name,
                                                         const gchar *stitle,
                                                         const gchar *icon_filename);
void                anjuta_preferences_remove_page      (AnjutaPreferences *pr,
                                                         const gchar *page_name);
void                anjuta_preferences_register_all_properties_from_builder_xml
                                                        (AnjutaPreferences *pr,
                                                         GtkBuilder *builder,
                                                         GSettings *settings,
                                                         GtkWidget *parent);
gboolean            anjuta_preferences_register_property
                                                        (AnjutaPreferences *pr,
                                                         GSettings *settings,
                                                         GtkWidget *object,
                                                         const gchar *key);
GtkWidget *         anjuta_preferences_get_dialog       (AnjutaPreferences *pr);
gboolean            anjuta_preferences_is_dialog_created
                                                        (AnjutaPreferences *pr);
                    AnjutaProperty;
                    AnjutaPreferencesPriv;

Object Hierarchy

  GObject
   +----AnjutaPreferences

Description

AnjutaPreferences is a way to let plugins register their preferences. There are mainly two ways a plugin could register its preferences in Anjuta.

First is to not use AnjutaPreferences at all. Simply register a preferences page in AnjutaPreferencesDialog using the function anjuta_preferences_dialog_add_page(). The plugin should take care of loading, saving and widgets synchronization of the preferences values. This can be done using GSettings bindings for example.

Second is to use anjuta_preferences_add_page(), which will automatically register the preferences keys and values from a glade xml file. The glade xml file contains a preferences page of the plugin. The widget names in the page are given in a particular way (see anjuta_preferences_add_page()) to let it know property key details. The preference dialog will automatically setup the bindings between GSettings and the widgets.

Details

anjuta_property_get_widget ()

GtkWidget *         anjuta_property_get_widget          (AnjutaProperty *prop);

struct AnjutaPreferences

struct AnjutaPreferences;

struct AnjutaPreferencesClass

struct AnjutaPreferencesClass {
	GObjectClass parent;
};