summaryrefslogtreecommitdiff
path: root/pluma/pluma-prefs-manager.h
diff options
context:
space:
mode:
Diffstat (limited to 'pluma/pluma-prefs-manager.h')
-rwxr-xr-xpluma/pluma-prefs-manager.h423
1 files changed, 423 insertions, 0 deletions
diff --git a/pluma/pluma-prefs-manager.h b/pluma/pluma-prefs-manager.h
new file mode 100755
index 00000000..f14fa431
--- /dev/null
+++ b/pluma/pluma-prefs-manager.h
@@ -0,0 +1,423 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
+/*
+ * pluma-prefs-manager.h
+ * This file is part of pluma
+ *
+ * Copyright (C) 2002 Paolo Maggi
+ *
+ * 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.
+ */
+
+/*
+ * Modified by the pluma Team, 2002. See the AUTHORS file for a
+ * list of people on the pluma Team.
+ * See the ChangeLog files for a list of changes.
+ */
+
+#ifndef __PLUMA_PREFS_MANAGER_H__
+#define __PLUMA_PREFS_MANAGER_H__
+
+#include <gtk/gtk.h>
+#include <glib.h>
+#include <gtksourceview/gtksourceview.h>
+#include "pluma-app.h"
+
+#define PLUMA_BASE_KEY "/apps/pluma-2"
+
+#define GPM_PREFS_DIR PLUMA_BASE_KEY "/preferences"
+
+/* Editor */
+#define GPM_FONT_DIR GPM_PREFS_DIR "/editor/font"
+#define GPM_USE_DEFAULT_FONT GPM_FONT_DIR "/use_default_font"
+#define GPM_EDITOR_FONT GPM_FONT_DIR "/editor_font"
+#define GPM_SYSTEM_FONT "/desktop/mate/interface/monospace_font_name"
+
+#define GPM_SAVE_DIR GPM_PREFS_DIR "/editor/save"
+#define GPM_CREATE_BACKUP_COPY GPM_SAVE_DIR "/create_backup_copy"
+
+#define GPM_AUTO_SAVE GPM_SAVE_DIR "/auto_save"
+#define GPM_AUTO_SAVE_INTERVAL GPM_SAVE_DIR "/auto_save_interval"
+
+#define GPM_UNDO_DIR GPM_PREFS_DIR "/editor/undo"
+#define GPM_UNDO_ACTIONS_LIMIT GPM_UNDO_DIR "/max_undo_actions"
+
+#define GPM_WRAP_MODE_DIR GPM_PREFS_DIR "/editor/wrap_mode"
+#define GPM_WRAP_MODE GPM_WRAP_MODE_DIR "/wrap_mode"
+
+#define GPM_TABS_DIR GPM_PREFS_DIR "/editor/tabs"
+#define GPM_TABS_SIZE GPM_TABS_DIR "/tabs_size"
+#define GPM_INSERT_SPACES GPM_TABS_DIR "/insert_spaces"
+
+#define GPM_AUTO_INDENT_DIR GPM_PREFS_DIR "/editor/auto_indent"
+#define GPM_AUTO_INDENT GPM_AUTO_INDENT_DIR "/auto_indent"
+
+#define GPM_LINE_NUMBERS_DIR GPM_PREFS_DIR "/editor/line_numbers"
+#define GPM_DISPLAY_LINE_NUMBERS GPM_LINE_NUMBERS_DIR "/display_line_numbers"
+
+#define GPM_CURRENT_LINE_DIR GPM_PREFS_DIR "/editor/current_line"
+#define GPM_HIGHLIGHT_CURRENT_LINE GPM_CURRENT_LINE_DIR "/highlight_current_line"
+
+#define GPM_BRACKET_MATCHING_DIR GPM_PREFS_DIR "/editor/bracket_matching"
+#define GPM_BRACKET_MATCHING GPM_BRACKET_MATCHING_DIR "/bracket_matching"
+
+#define GPM_RIGHT_MARGIN_DIR GPM_PREFS_DIR "/editor/right_margin"
+#define GPM_DISPLAY_RIGHT_MARGIN GPM_RIGHT_MARGIN_DIR "/display_right_margin"
+#define GPM_RIGHT_MARGIN_POSITION GPM_RIGHT_MARGIN_DIR "/right_margin_position"
+
+#define GPM_SMART_HOME_END_DIR GPM_PREFS_DIR "/editor/smart_home_end"
+#define GPM_SMART_HOME_END GPM_SMART_HOME_END_DIR "/smart_home_end"
+
+#define GPM_CURSOR_POSITION_DIR GPM_PREFS_DIR "/editor/cursor_position"
+#define GPM_RESTORE_CURSOR_POSITION GPM_CURSOR_POSITION_DIR "/restore_cursor_position"
+
+#define GPM_SEARCH_HIGHLIGHTING_DIR GPM_PREFS_DIR "/editor/search_highlighting"
+#define GPM_SEARCH_HIGHLIGHTING_ENABLE GPM_SEARCH_HIGHLIGHTING_DIR "/enable"
+
+#define GPM_SOURCE_STYLE_DIR GPM_PREFS_DIR "/editor/colors"
+#define GPM_SOURCE_STYLE_SCHEME GPM_SOURCE_STYLE_DIR "/scheme"
+
+/* UI */
+#define GPM_TOOLBAR_DIR GPM_PREFS_DIR "/ui/toolbar"
+#define GPM_TOOLBAR_VISIBLE GPM_TOOLBAR_DIR "/toolbar_visible"
+#define GPM_TOOLBAR_BUTTONS_STYLE GPM_TOOLBAR_DIR "/toolbar_buttons_style"
+
+#define GPM_STATUSBAR_DIR GPM_PREFS_DIR "/ui/statusbar"
+#define GPM_STATUSBAR_VISIBLE GPM_STATUSBAR_DIR "/statusbar_visible"
+
+#define GPM_SIDE_PANE_DIR GPM_PREFS_DIR "/ui/side_pane"
+#define GPM_SIDE_PANE_VISIBLE GPM_SIDE_PANE_DIR "/side_pane_visible"
+
+#define GPM_BOTTOM_PANEL_DIR GPM_PREFS_DIR "/ui/bottom_panel"
+#define GPM_BOTTOM_PANEL_VISIBLE GPM_BOTTOM_PANEL_DIR "/bottom_panel_visible"
+
+#define GPM_RECENTS_DIR GPM_PREFS_DIR "/ui/recents"
+#define GPM_MAX_RECENTS GPM_RECENTS_DIR "/max_recents"
+
+/* Print */
+#define GPM_PRINT_PAGE_DIR GPM_PREFS_DIR "/print/page"
+#define GPM_PRINT_SYNTAX GPM_PRINT_PAGE_DIR "/print_syntax_highlighting"
+#define GPM_PRINT_HEADER GPM_PRINT_PAGE_DIR "/print_header"
+#define GPM_PRINT_WRAP_MODE GPM_PRINT_PAGE_DIR "/print_wrap_mode"
+#define GPM_PRINT_LINE_NUMBERS GPM_PRINT_PAGE_DIR "/print_line_numbers"
+
+#define GPM_PRINT_FONT_DIR GPM_PREFS_DIR "/print/fonts"
+#define GPM_PRINT_FONT_BODY GPM_PRINT_FONT_DIR "/print_font_body_pango"
+#define GPM_PRINT_FONT_HEADER GPM_PRINT_FONT_DIR "/print_font_header_pango"
+#define GPM_PRINT_FONT_NUMBERS GPM_PRINT_FONT_DIR "/print_font_numbers_pango"
+
+/* Encodings */
+#define GPM_ENCODINGS_DIR GPM_PREFS_DIR "/encodings"
+#define GPM_AUTO_DETECTED_ENCODINGS GPM_ENCODINGS_DIR "/auto_detected"
+#define GPM_SHOWN_IN_MENU_ENCODINGS GPM_ENCODINGS_DIR "/shown_in_menu"
+
+/* Syntax highlighting */
+#define GPM_SYNTAX_HL_DIR GPM_PREFS_DIR "/syntax_highlighting"
+#define GPM_SYNTAX_HL_ENABLE GPM_SYNTAX_HL_DIR "/enable"
+
+/* White list of writable mate-vfs methods */
+#define GPM_WRITABLE_VFS_SCHEMES GPM_SAVE_DIR "/writable_vfs_schemes"
+
+/* Plugins */
+#define GPM_PLUGINS_DIR PLUMA_BASE_KEY "/plugins"
+#define GPM_ACTIVE_PLUGINS GPM_PLUGINS_DIR "/active-plugins"
+
+/* Global Lockdown keys */
+#define GPM_LOCKDOWN_DIR "/desktop/mate/lockdown"
+#define GPM_LOCKDOWN_COMMAND_LINE GPM_LOCKDOWN_DIR "/disable_command_line"
+#define GPM_LOCKDOWN_PRINTING GPM_LOCKDOWN_DIR "/disable_printing"
+#define GPM_LOCKDOWN_PRINT_SETUP GPM_LOCKDOWN_DIR "/disable_print_setup"
+#define GPM_LOCKDOWN_SAVE_TO_DISK GPM_LOCKDOWN_DIR "/disable_save_to_disk"
+
+/* Fallback default values. Keep in sync with pluma.schemas */
+
+#define GPM_DEFAULT_USE_DEFAULT_FONT 1 /* TRUE */
+
+#ifndef PLATFORM_OSX
+#define GPM_DEFAULT_EDITOR_FONT (const gchar*) "Monospace 12"
+#define GPM_DEFAULT_SYSTEM_FONT (const gchar*) "Monospace 10"
+#else
+#define GPM_DEFAULT_EDITOR_FONT (const gchar*) "Monaco 12"
+#define GPM_DEFAULT_SYSTEM_FONT (const gchar*) "Monaco 12"
+#endif
+
+#define GPM_DEFAULT_CREATE_BACKUP_COPY 0 /* FALSE */
+
+#define GPM_DEFAULT_AUTO_SAVE 0 /* FALSE */
+#define GPM_DEFAULT_AUTO_SAVE_INTERVAL 10 /* minutes */
+
+#define GPM_DEFAULT_UNDO_ACTIONS_LIMIT 2000 /* actions */
+
+#define GPM_DEFAULT_WRAP_MODE "GTK_WRAP_WORD"
+
+#define GPM_DEFAULT_TABS_SIZE 8
+#define GPM_DEFAULT_INSERT_SPACES 0 /* FALSE */
+
+#define GPM_DEFAULT_AUTO_INDENT 0 /* FALSE */
+
+#define GPM_DEFAULT_DISPLAY_LINE_NUMBERS 0 /* FALSE */
+
+#define GPM_DEFAULT_AUTO_DETECTED_ENCODINGS {"UTF-8", "CURRENT", "ISO-8859-15", NULL}
+
+#define GPM_DEFAULT_TOOLBAR_VISIBLE 1 /* TRUE */
+#define GPM_DEFAULT_TOOLBAR_BUTTONS_STYLE "PLUMA_TOOLBAR_SYSTEM"
+#define GPM_DEFAULT_TOOLBAR_SHOW_TOOLTIPS 1 /* TRUE */
+
+#define GPM_DEFAULT_STATUSBAR_VISIBLE 1 /* TRUE */
+#define GPM_DEFAULT_SIDE_PANE_VISIBLE 0 /* FALSE */
+#define GPM_DEFAULT_BOTTOM_PANEL_VISIBLE 0 /* FALSE */
+
+#define GPM_DEFAULT_PRINT_SYNTAX 1 /* TRUE */
+#define GPM_DEFAULT_PRINT_HEADER 1 /* TRUE */
+#define GPM_DEFAULT_PRINT_WRAP_MODE "GTK_WRAP_WORD"
+#define GPM_DEFAULT_PRINT_LINE_NUMBERS 0 /* No numbers */
+
+#ifndef PLATFORM_OSX
+#define GPM_DEFAULT_PRINT_FONT_BODY (const gchar*) "Monospace 9"
+#else
+#define GPM_DEFAULT_PRINT_FONT_BODY (const gchar*) "Monaco 10"
+#endif
+
+#define GPM_DEFAULT_PRINT_FONT_HEADER (const gchar*) "Sans 11"
+#define GPM_DEFAULT_PRINT_FONT_NUMBERS (const gchar*) "Sans 8"
+
+#define GPM_DEFAULT_MAX_RECENTS 5
+
+#define GPM_DEFAULT_HIGHLIGHT_CURRENT_LINE 1 /* TRUE */
+
+#define GPM_DEFAULT_BRACKET_MATCHING 0 /* FALSE */
+
+#define GPM_DEFAULT_DISPLAY_RIGHT_MARGIN 0 /* FALSE */
+#define GPM_DEFAULT_RIGHT_MARGIN_POSITION 80
+
+#define GPM_DEFAULT_SMART_HOME_END "AFTER"
+
+#define GPM_DEFAULT_SYNTAX_HL_ENABLE 1 /* TRUE */
+
+#define GPM_DEFAULT_WRITABLE_VFS_SCHEMES {"ssh", "sftp", "smb", "dav", "davs", NULL}
+
+#define GPM_DEFAULT_RESTORE_CURSOR_POSITION 1 /* TRUE */
+
+#define GPM_DEFAULT_SEARCH_HIGHLIGHTING_ENABLE 1 /* TRUE */
+
+#define GPM_DEFAULT_SOURCE_STYLE_SCHEME "classic"
+
+typedef enum {
+ PLUMA_TOOLBAR_SYSTEM = 0,
+ PLUMA_TOOLBAR_ICONS,
+ PLUMA_TOOLBAR_ICONS_AND_TEXT,
+ PLUMA_TOOLBAR_ICONS_BOTH_HORIZ
+} PlumaToolbarSetting;
+
+/** LIFE CYCLE MANAGEMENT FUNCTIONS **/
+
+gboolean pluma_prefs_manager_init (void);
+
+/* This function must be called before exiting pluma */
+void pluma_prefs_manager_shutdown (void);
+
+
+/** PREFS MANAGEMENT FUNCTIONS **/
+
+/* Use default font */
+gboolean pluma_prefs_manager_get_use_default_font (void);
+void pluma_prefs_manager_set_use_default_font (gboolean udf);
+gboolean pluma_prefs_manager_use_default_font_can_set (void);
+
+/* Editor font */
+gchar *pluma_prefs_manager_get_editor_font (void);
+void pluma_prefs_manager_set_editor_font (const gchar *font);
+gboolean pluma_prefs_manager_editor_font_can_set (void);
+
+/* System font */
+gchar *pluma_prefs_manager_get_system_font (void);
+
+/* Create backup copy */
+gboolean pluma_prefs_manager_get_create_backup_copy (void);
+void pluma_prefs_manager_set_create_backup_copy (gboolean cbc);
+gboolean pluma_prefs_manager_create_backup_copy_can_set (void);
+
+/* Auto save */
+gboolean pluma_prefs_manager_get_auto_save (void);
+void pluma_prefs_manager_set_auto_save (gboolean as);
+gboolean pluma_prefs_manager_auto_save_can_set (void);
+
+/* Auto save interval */
+gint pluma_prefs_manager_get_auto_save_interval (void);
+void pluma_prefs_manager_set_auto_save_interval (gint asi);
+gboolean pluma_prefs_manager_auto_save_interval_can_set (void);
+
+/* Undo actions limit: if < 1 then no limits */
+gint pluma_prefs_manager_get_undo_actions_limit (void);
+void pluma_prefs_manager_set_undo_actions_limit (gint ual);
+gboolean pluma_prefs_manager_undo_actions_limit_can_set (void);
+
+/* Wrap mode */
+GtkWrapMode pluma_prefs_manager_get_wrap_mode (void);
+void pluma_prefs_manager_set_wrap_mode (GtkWrapMode wp);
+gboolean pluma_prefs_manager_wrap_mode_can_set (void);
+
+/* Tabs size */
+gint pluma_prefs_manager_get_tabs_size (void);
+void pluma_prefs_manager_set_tabs_size (gint ts);
+gboolean pluma_prefs_manager_tabs_size_can_set (void);
+
+/* Insert spaces */
+gboolean pluma_prefs_manager_get_insert_spaces (void);
+void pluma_prefs_manager_set_insert_spaces (gboolean ai);
+gboolean pluma_prefs_manager_insert_spaces_can_set (void);
+
+/* Auto indent */
+gboolean pluma_prefs_manager_get_auto_indent (void);
+void pluma_prefs_manager_set_auto_indent (gboolean ai);
+gboolean pluma_prefs_manager_auto_indent_can_set (void);
+
+/* Display line numbers */
+gboolean pluma_prefs_manager_get_display_line_numbers (void);
+void pluma_prefs_manager_set_display_line_numbers (gboolean dln);
+gboolean pluma_prefs_manager_display_line_numbers_can_set (void);
+
+/* Toolbar visible */
+gboolean pluma_prefs_manager_get_toolbar_visible (void);
+void pluma_prefs_manager_set_toolbar_visible (gboolean tv);
+gboolean pluma_prefs_manager_toolbar_visible_can_set (void);
+
+/* Toolbar buttons style */
+PlumaToolbarSetting pluma_prefs_manager_get_toolbar_buttons_style (void);
+void pluma_prefs_manager_set_toolbar_buttons_style (PlumaToolbarSetting tbs);
+gboolean pluma_prefs_manager_toolbar_buttons_style_can_set (void);
+
+/* Statusbar visible */
+gboolean pluma_prefs_manager_get_statusbar_visible (void);
+void pluma_prefs_manager_set_statusbar_visible (gboolean sv);
+gboolean pluma_prefs_manager_statusbar_visible_can_set (void);
+
+/* Side pane visible */
+gboolean pluma_prefs_manager_get_side_pane_visible (void);
+void pluma_prefs_manager_set_side_pane_visible (gboolean tv);
+gboolean pluma_prefs_manager_side_pane_visible_can_set (void);
+
+/* Bottom panel visible */
+gboolean pluma_prefs_manager_get_bottom_panel_visible (void);
+void pluma_prefs_manager_set_bottom_panel_visible (gboolean tv);
+gboolean pluma_prefs_manager_bottom_panel_visible_can_set(void);
+/* Print syntax highlighting */
+gboolean pluma_prefs_manager_get_print_syntax_hl (void);
+void pluma_prefs_manager_set_print_syntax_hl (gboolean ps);
+gboolean pluma_prefs_manager_print_syntax_hl_can_set (void);
+
+/* Print header */
+gboolean pluma_prefs_manager_get_print_header (void);
+void pluma_prefs_manager_set_print_header (gboolean ph);
+gboolean pluma_prefs_manager_print_header_can_set (void);
+
+/* Wrap mode while printing */
+GtkWrapMode pluma_prefs_manager_get_print_wrap_mode (void);
+void pluma_prefs_manager_set_print_wrap_mode (GtkWrapMode pwm);
+gboolean pluma_prefs_manager_print_wrap_mode_can_set (void);
+
+/* Print line numbers */
+gint pluma_prefs_manager_get_print_line_numbers (void);
+void pluma_prefs_manager_set_print_line_numbers (gint pln);
+gboolean pluma_prefs_manager_print_line_numbers_can_set (void);
+
+/* Font used to print the body of documents */
+gchar *pluma_prefs_manager_get_print_font_body (void);
+void pluma_prefs_manager_set_print_font_body (const gchar *font);
+gboolean pluma_prefs_manager_print_font_body_can_set (void);
+const gchar *pluma_prefs_manager_get_default_print_font_body (void);
+
+/* Font used to print headers */
+gchar *pluma_prefs_manager_get_print_font_header (void);
+void pluma_prefs_manager_set_print_font_header (const gchar *font);
+gboolean pluma_prefs_manager_print_font_header_can_set (void);
+const gchar *pluma_prefs_manager_get_default_print_font_header (void);
+
+/* Font used to print line numbers */
+gchar *pluma_prefs_manager_get_print_font_numbers (void);
+void pluma_prefs_manager_set_print_font_numbers (const gchar *font);
+gboolean pluma_prefs_manager_print_font_numbers_can_set (void);
+const gchar *pluma_prefs_manager_get_default_print_font_numbers (void);
+
+/* Max number of files in "Recent Files" menu.
+ * This is configurable only using mateconftool or mateconf-editor
+ */
+gint pluma_prefs_manager_get_max_recents (void);
+
+/* Encodings */
+GSList *pluma_prefs_manager_get_auto_detected_encodings (void);
+
+GSList *pluma_prefs_manager_get_shown_in_menu_encodings (void);
+void pluma_prefs_manager_set_shown_in_menu_encodings (const GSList *encs);
+gboolean pluma_prefs_manager_shown_in_menu_encodings_can_set (void);
+
+/* Highlight current line */
+gboolean pluma_prefs_manager_get_highlight_current_line (void);
+void pluma_prefs_manager_set_highlight_current_line (gboolean hl);
+gboolean pluma_prefs_manager_highlight_current_line_can_set (void);
+
+/* Highlight matching bracket */
+gboolean pluma_prefs_manager_get_bracket_matching (void);
+void pluma_prefs_manager_set_bracket_matching (gboolean bm);
+gboolean pluma_prefs_manager_bracket_matching_can_set (void);
+
+/* Display right margin */
+gboolean pluma_prefs_manager_get_display_right_margin (void);
+void pluma_prefs_manager_set_display_right_margin (gboolean drm);
+gboolean pluma_prefs_manager_display_right_margin_can_set (void);
+
+/* Right margin position */
+gint pluma_prefs_manager_get_right_margin_position (void);
+void pluma_prefs_manager_set_right_margin_position (gint rmp);
+gboolean pluma_prefs_manager_right_margin_position_can_set (void);
+
+/* Smart home end */
+GtkSourceSmartHomeEndType
+ pluma_prefs_manager_get_smart_home_end (void);
+void pluma_prefs_manager_set_smart_home_end (GtkSourceSmartHomeEndType smart_he);
+gboolean pluma_prefs_manager_smart_home_end_can_set (void);
+
+/* Enable syntax highlighting */
+gboolean pluma_prefs_manager_get_enable_syntax_highlighting (void);
+void pluma_prefs_manager_set_enable_syntax_highlighting (gboolean esh);
+gboolean pluma_prefs_manager_enable_syntax_highlighting_can_set (void);
+
+/* Writable VFS schemes */
+GSList *pluma_prefs_manager_get_writable_vfs_schemes (void);
+
+/* Restore cursor position */
+gboolean pluma_prefs_manager_get_restore_cursor_position (void);
+
+/* Enable search highlighting */
+gboolean pluma_prefs_manager_get_enable_search_highlighting (void);
+void pluma_prefs_manager_set_enable_search_highlighting (gboolean esh);
+gboolean pluma_prefs_manager_enable_search_highlighting_can_set (void);
+
+/* Style scheme */
+gchar *pluma_prefs_manager_get_source_style_scheme (void);
+void pluma_prefs_manager_set_source_style_scheme (const gchar *scheme);
+gboolean pluma_prefs_manager_source_style_scheme_can_set(void);
+
+/* Plugins */
+GSList *pluma_prefs_manager_get_active_plugins (void);
+void pluma_prefs_manager_set_active_plugins (const GSList *plugins);
+gboolean pluma_prefs_manager_active_plugins_can_set (void);
+
+/* Global lockdown */
+PlumaLockdownMask pluma_prefs_manager_get_lockdown (void);
+
+#endif /* __PLUMA_PREFS_MANAGER_H__ */
+
+