/* * preferences.h * Copyright (C) 2000 - 2003 Naba Kumar * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _PREFERENCES_H_ #define _PREFERENCES_H_ #include #include #include #include #ifdef __cplusplus extern "C" { #endif typedef enum { ANJUTA_PROPERTY_OBJECT_TYPE_TOGGLE, ANJUTA_PROPERTY_OBJECT_TYPE_SPIN, ANJUTA_PROPERTY_OBJECT_TYPE_ENTRY, ANJUTA_PROPERTY_OBJECT_TYPE_MENU, ANJUTA_PROPERTY_OBJECT_TYPE_TEXT, ANJUTA_PROPERTY_OBJECT_TYPE_COLOR, ANJUTA_PROPERTY_OBJECT_TYPE_FONT } AnjutaPropertyObjectType; typedef enum { ANJUTA_PROPERTY_DATA_TYPE_BOOL, ANJUTA_PROPERTY_DATA_TYPE_INT, ANJUTA_PROPERTY_DATA_TYPE_TEXT, ANJUTA_PROPERTY_DATA_TYPE_COLOR, ANJUTA_PROPERTY_DATA_TYPE_FONT } AnjutaPropertyDataType; typedef enum { ANJUTA_PREFERENCES_FILTER_NONE = 0, ANJUTA_PREFERENCES_FILTER_PROJECT = 1 } AnjutaPreferencesFilterType; typedef struct _AnjutaProperty AnjutaProperty; /* Gets the widget associated with the property */ GtkWidget* anjuta_property_get_widget (AnjutaProperty *prop); #define ANJUTA_TYPE_PREFERENCES (anjuta_preferences_get_type ()) #define ANJUTA_PREFERENCES(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), ANJUTA_TYPE_PREFERENCES, AnjutaPreferences)) #define ANJUTA_PREFERENCES_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), ANJUTA_TYPE_PREFERENCES, AnjutaPreferencesClass)) #define ANJUTA_IS_PREFERENCES(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), ANJUTA_TYPE_PREFERENCES)) #define ANJUTA_IS_PREFERENCES_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), ANJUTA_TYPE_PREFERENCES)) typedef struct _AnjutaPreferences AnjutaPreferences; typedef struct _AnjutaPreferencesClass AnjutaPreferencesClass; typedef struct _AnjutaPreferencesPriv AnjutaPreferencesPriv; struct _AnjutaPreferences { AnjutaPreferencesDialog parent; PropsID props_built_in; PropsID props_global; PropsID props_local; PropsID props_session; PropsID props; AnjutaPreferencesPriv *priv; }; struct _AnjutaPreferencesClass { AnjutaPreferencesDialogClass parent; void (*changed) (GtkWidget *pref); }; typedef gboolean (*AnjutaPreferencesCallback) (AnjutaPreferences *pr, const gchar *key, gpointer data); GType anjuta_preferences_get_type (void); /* Preferences */ GtkWidget *anjuta_preferences_new (void); /* Add a page to the preferences sytem. * gxml: The GladeXML object of the glade dialog containing the page widget. * The glade dialog will contain the layout of the preferences widgets. * The widgets which are preference widgets (e.g. toggle button) should have * widget names of the form: * preferences_OBJECTTYPE:DATATYPE:DEFAULT:FLAGS:PROPERTYKEY * where, * OBJECTTYPE is 'toggle', 'spin', 'entry', 'text', 'color' or 'font'. * DATATYPE is 'bool', 'int', 'float', 'text', 'color' or 'font'. * DEFAULT is the default value (in the appropriate format). The format * for color is '#XXXXXX' representing RGB value and for * font, it is the pango font description. * FLAGS is any flag associated with the property. Currently it * has only two values -- 0 and 1. For normal preference * property which is saved/retrieved globally, the flag = 0. * For preference property which is also saved/retrieved * along with the project, the flag = 1. * PROPERTYKEY is the property key. e.g - 'tab.size'. * * All widgets having the above names in the gxml tree will be registered * and will become part of auto saving/loading. For example, refer to * anjuta preferences dialogs and study the widget names. * * glade_widget_name: Page widget name (as give with glade interface editor). * The widget will be searched with the given name and detached * (that is, removed from the container, if present) from it's parent. * * icon_filename: File name (of the form filename.png) of the icon representing * the preference page. */ void anjuta_preferences_add_page (AnjutaPreferences* pr, GladeXML *gxml, const char* glade_widget_name, const gchar *icon_filename); /* This will register all the properties names of the format described above * without considering the UI. Useful if you have the widgets shown elsewhere * but you want them to be part of preferences system. */ void anjuta_preferences_register_all_properties_from_glade_xml (AnjutaPreferences* pr, GladeXML *gxml, GtkWidget *parent); /* This registers only one widget. The widget could be shown elsewhere. * the property_description should be of the form described before. */ gboolean anjuta_preferences_register_property_from_string (AnjutaPreferences *pr, GtkWidget *object, const gchar *property_desc); /* This also registers only one widget, but instead of supplying the property * parameters as a single parsable string (as done in previous method), it * takes them separately. */ gboolean anjuta_preferences_register_property_raw (AnjutaPreferences *pr, GtkWidget *object, const gchar *key, const gchar *default_value, guint flags, AnjutaPropertyObjectType object_type, AnjutaPropertyDataType data_type); /* This is meant for complex widgets which can not be set/get with the * standard object set/get methods. Custom set/get methods are passed for * the property to set/get the value to/from the widget. */ gboolean anjuta_preferences_register_property_custom (AnjutaPreferences *pr, GtkWidget *object, const gchar *key, const gchar *default_value, guint flags, void (*set_property) (AnjutaProperty *prop, const gchar *value), gchar * (*get_property) (AnjutaProperty *)); /* Resets the default values into the keys */ void anjuta_preferences_reset_defaults (AnjutaPreferences *); /* Save and (Loading is done in _new()) */ gboolean anjuta_preferences_save (AnjutaPreferences * p, FILE * stream); /* Save excluding the filtered properties. This will save only those * properties which DOES NOT have the flags set to values given by the filter. */ gboolean anjuta_preferences_save_filtered (AnjutaPreferences * p, FILE * stream, AnjutaPreferencesFilterType filter); /* Calls the callback function for each of the properties with the flags * matching with the given filter */ void anjuta_preferences_foreach (AnjutaPreferences * pr, AnjutaPreferencesFilterType filter, AnjutaPreferencesCallback callback, gpointer data); /* This will transfer all the properties values from the main properties database to the parent session properties database */ void anjuta_preferences_sync_to_session (AnjutaPreferences *pr); /* Sets the value (string) of a key */ void anjuta_preferences_set (AnjutaPreferences *, gchar * key, gchar * value); /* Sets the value (int) of a key */ void anjuta_preferences_set_int (AnjutaPreferences *, gchar * key, gint value); /* Gets the value (string) of a key */ /* Must free the return string */ gchar * anjuta_preferences_get (AnjutaPreferences * p, gchar * key); /* Gets the value (int) of a key. If not found, 0 is returned */ gint anjuta_preferences_get_int (AnjutaPreferences * p, gchar * key); /* Gets the value (int) of a key. If not found, the default_value is returned */ gint anjuta_preferences_get_int_with_default (AnjutaPreferences * p, gchar *key, gint default_value); gchar * anjuta_preferences_default_get (AnjutaPreferences * p, gchar * key); /* Gets the value (int) of a key */ gint anjuta_preferences_default_get_int (AnjutaPreferences * p, gchar * key); /* * Preferences KEY definitions. * * Use the keys instead of using the strings directly. * * Call these as the second arg of the * functions preferences_get_*() or preferences_set_*() to * read or write a preference value the preferences variables. */ #define PROJECTS_DIRECTORY "projects.directory" #define TARBALLS_DIRECTORY "tarballs.directory" #define RPMS_DIRECTORY "rpms.directory" #define SRPMS_DIRECTORY "srpms.directory" #define MAXIMUM_RECENT_PROJECTS "maximum.recent.projects" #define MAXIMUM_RECENT_FILES "maximum.recent.files" #define MAXIMUM_COMBO_HISTORY "maximum.combo.history" #define DIALOG_ON_BUILD_COMPLETE "dialog.on.build.complete" #define BEEP_ON_BUILD_COMPLETE "beep.on.build.complete" #define RELOAD_LAST_PROJECT "reload.last.project" #define BUILD_OPTION_KEEP_GOING "build.option.keep.going" #define BUILD_OPTION_DEBUG "build.option.debug" #define BUILD_OPTION_SILENT "build.option.silent" #define BUILD_OPTION_WARN_UNDEF "build.option.warn.undef" #define BUILD_OPTION_JOBS "build.option.jobs" #define BUILD_OPTION_AUTOSAVE "build.option.autosave" #define DISABLE_SYNTAX_HILIGHTING "disable.syntax.hilighting" #define SAVE_AUTOMATIC "save.automatic" #define INDENT_AUTOMATIC "indent.automatic" #define USE_TABS "use.tabs" #define BRACES_CHECK "braces.check" #define DOS_EOL_CHECK "editor.doseol" #define WRAP_BOOKMARKS "editor.wrapbookmarks" #define TAB_SIZE "tabsize" #define INDENT_SIZE "indent.size" #define INDENT_OPENING "indent.opening" #define INDENT_CLOSING "indent.closing" #define AUTOSAVE_TIMER "autosave.timer" #define MARGIN_LINENUMBER_WIDTH "margin.linenumber.width" #define SAVE_SESSION_TIMER "save.session.timer" #define AUTOFORMAT_DISABLE "autoformat.disable" #define AUTOFORMAT_CUSTOM_STYLE "autoformat.custom.style" #define AUTOFORMAT_STYLE "autoformat.style" #define EDITOR_TABS_POS "editor.tabs.pos" #define EDITOR_TABS_HIDE "editor.tabs.hide" #define EDITOR_TABS_ORDERING "editor.tabs.ordering" #define EDITOR_TABS_RECENT_FIRST "editor.tabs.recent.first" /* Character encodings */ #define SAVE_ENCODING_ORIGINAL "save.encoding.original" #define SAVE_ENCODING_CURRENT_LOCALE "save.encoding.current.locale" #define SUPPORTED_ENCODINGS "supported.encodings" #define STRIP_TRAILING_SPACES "strip.trailing.spaces" #define FOLD_ON_OPEN "fold.on.open" #define CARET_FORE_COLOR "caret.fore" #define CALLTIP_BACK_COLOR "calltip.back" #define SELECTION_FORE_COLOR "selection.fore" #define SELECTION_BACK_COLOR "selection.back" #define TEXT_ZOOM_FACTOR "text.zoom.factor" #define TRUNCAT_MESSAGES "truncat.messages" #define TRUNCAT_MESG_FIRST "truncat.mesg.first" #define TRUNCAT_MESG_LAST "truncat.mesg.last" #define MESSAGES_TAG_POS "messages.tag.position" #define MESSAGES_COLOR_ERROR "messages.color.error" #define MESSAGES_COLOR_WARNING "messages.color.warning" #define MESSAGES_COLOR_MESSAGES1 "messages.color.messages1" #define MESSAGES_COLOR_MESSAGES2 "messages.color.messages2" #define MESSAGES_INDICATORS_AUTOMATIC "indicators.automatic" #define AUTOMATIC_TAGS_UPDATE "automatic.tags.update" #define BUILD_SYMBOL_BROWSER "build.symbol.browser" #define BUILD_FILE_BROWSER "build.file.browser" #define SHOW_TOOLTIPS "show.tooltips" #define PRINT_PAPER_SIZE "print.paper.size" #define PRINT_HEADER "print.header" #define PRINT_WRAP "print.linewrap" #define PRINT_LINENUM_COUNT "print.linenumber.count" #define PRINT_LANDSCAPE "print.landscape" #define PRINT_MARGIN_LEFT "print.margin.left" #define PRINT_MARGIN_RIGHT "print.margin.right" #define PRINT_MARGIN_TOP "print.margin.top" #define PRINT_MARGIN_BOTTOM "print.margin.bottom" #define PRINT_COLOR "print.color" #define USE_COMPONENTS "components.enable" #define IDENT_NAME "ident.name" #define IDENT_EMAIL "ident.email" #ifdef __cplusplus }; #endif #endif