4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
15 * Full author contact details are available in file CREDITS.
23 #include "support/strfwd.h"
32 namespace support { class FileName; }
36 /// This contains the runtime configuration of LyX
41 RC_ACCEPT_COMPOUND = 1,
43 RC_AUTOCORRECTION_MATH,
49 RC_BIBTEX_ALTERNATIVES,
54 RC_COMPLETION_CURSOR_TEXT,
55 RC_COMPLETION_INLINE_DELAY,
56 RC_COMPLETION_INLINE_MATH,
57 RC_COMPLETION_INLINE_TEXT,
58 RC_COMPLETION_INLINE_DOTS,
59 RC_COMPLETION_MINLENGTH,
60 RC_COMPLETION_POPUP_DELAY,
61 RC_COMPLETION_POPUP_MATH,
62 RC_COMPLETION_POPUP_TEXT,
63 RC_COMPLETION_POPUP_AFTER_COMPLETE,
65 RC_CONVERTER_CACHE_MAXAGE,
67 RC_CURSOR_FOLLOWS_SCROLLBAR,
69 RC_DEFAULT_DECIMAL_POINT,
70 RC_DEFAULT_LENGTH_UNIT,
71 RC_DEFAULT_OTF_VIEW_FORMAT,
72 RC_DEFAULT_PLATEX_VIEW_FORMAT,
73 RC_DEFAULT_VIEW_FORMAT,
75 RC_DIALOGS_ICONIFY_WITH_MAIN,
78 RC_EDITOR_ALTERNATIVES,
83 RC_FORWARD_SEARCH_DVI,
84 RC_FORWARD_SEARCH_PDF,
86 RC_FULL_SCREEN_SCROLLBAR,
87 RC_FULL_SCREEN_STATUSBAR,
88 RC_FULL_SCREEN_TABBAR,
89 RC_FULL_SCREEN_MENUBAR,
90 RC_FULL_SCREEN_TOOLBARS,
97 RC_INDEX_ALTERNATIVES,
100 RC_JBIBTEX_ALTERNATIVES,
106 RC_LANGUAGE_AUTO_BEGIN,
107 RC_LANGUAGE_AUTO_END,
108 RC_LANGUAGE_COMMAND_BEGIN,
109 RC_LANGUAGE_COMMAND_END,
110 RC_LANGUAGE_COMMAND_LOCAL,
111 RC_LANGUAGE_GLOBAL_OPTIONS,
112 RC_LANGUAGE_CUSTOM_PACKAGE,
113 RC_LANGUAGE_PACKAGE_SELECTION,
117 RC_MAC_DONTSWAP_CTRL_META,
118 RC_MAC_LIKE_CURSOR_MOVEMENT,
120 RC_MARK_FOREIGN_LANGUAGE,
121 RC_MOUSE_WHEEL_SPEED,
122 RC_MOUSE_MIDDLEBUTTON_PASTE,
125 RC_OPEN_BUFFERS_IN_TABS,
126 RC_PARAGRAPH_MARKERS,
128 RC_PLAINTEXT_LINELEN,
130 RC_PREVIEW_HASHED_LABELS,
131 RC_PREVIEW_SCALE_FACTOR,
132 RC_PRINTLANDSCAPEFLAG,
133 RC_PRINTPAPERDIMENSIONFLAG,
135 RC_PYGMENTIZE_COMMAND,
139 RC_SCREEN_FONT_ROMAN,
140 RC_SCREEN_FONT_ROMAN_FOUNDRY,
142 RC_SCREEN_FONT_SANS_FOUNDRY,
143 RC_SCREEN_FONT_SCALABLE,
144 RC_SCREEN_FONT_SIZES,
145 RC_SCREEN_FONT_TYPEWRITER,
146 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
148 RC_SCROLL_BELOW_DOCUMENT,
149 RC_SCROLL_WHEEL_ZOOM,
153 RC_SINGLE_CLOSE_TAB_BUTTON,
156 RC_SPELLCHECK_CONTINUOUSLY,
159 RC_SPLITINDEX_COMMAND,
162 RC_TEX_ALLOWS_SPACES,
163 RC_TEX_EXPECTS_WINDOWS_PATHS,
170 RC_USE_CONVERTER_CACHE,
171 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
172 RC_USE_CONVERTER_NEEDAUTH,
173 RC_USE_NATIVE_FILEDIALOG,
174 RC_USE_SYSTEM_COLORS,
177 RC_USE_SYSTEM_THEME_ICONS,
178 RC_VIEWDVI_PAPEROPTION,
180 RC_VIEWER_ALTERNATIVES,
182 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
190 /// \param check_format: whether to try to convert the file format,
191 /// if it is not current. this should only be true, really, for the
192 /// user's own preferences file.
193 bool read(support::FileName const & filename, bool check_format);
195 bool read(std::istream &);
203 ReturnValues read(Lexer &, bool check_format);
206 typedef std::set<std::string> CommandSet;
207 /// maps a format to a set of commands that can be used to
209 typedef std::map<std::string, CommandSet> Alternatives;
211 void write(support::FileName const & filename,
212 bool ignore_system_lyxrc) const;
213 /// write rc. If a specific tag is given, only output that one.
214 void write(std::ostream & os,
215 bool ignore_system_lyxrc,
216 std::string const & tag = std::string()) const;
220 std::set<std::string> getRCs();
221 // FIXME unused (was used for xforms. Do we still need this?)
222 //static docstring const getDescription(LyXRCTags);
224 std::string bind_file;
226 std::string def_file;
230 std::string print_landscape_flag;
232 std::string print_paper_flag;
234 std::string print_paper_dimension_flag;
235 /// option for telling the dvi viewer about the paper size
236 std::string view_dvi_paper_option;
237 /// default paper size for local xdvi/dvips/ghostview/whatever
238 /// command to run chktex incl. options
239 std::string chktex_command;
240 /// all available commands to run bibtex incl. options
241 CommandSet bibtex_alternatives;
242 /// command to run bibtex incl. options
243 std::string bibtex_command;
244 /// command to run japanese bibtex incl. options
245 std::string jbibtex_command;
246 /// all available commands to run japanese bibtex incl. options
247 CommandSet jbibtex_alternatives;
248 /// all available index commands incl. options
249 CommandSet index_alternatives;
250 /// command to run makeindex incl. options or other index programs
251 std::string index_command;
252 /// command to run japanese index program incl. options
253 std::string jindex_command;
254 /// command to generate multiple indices
255 std::string splitindex_command;
256 /// command to run makeindex incl. options for nomencl
257 std::string nomencl_command;
258 /// command to run the python pygments syntax highlighter
259 std::string pygmentize_command;
261 std::string document_path;
263 std::string example_path;
265 std::string template_path;
267 std::string tempdir_path;
269 std::string thesaurusdir_path;
271 std::string hunspelldir_path;
273 bool auto_region_delete;
274 /// enable middle-mouse-button paste
275 bool mouse_middlebutton_paste;
276 /// flag telling whether lastfiles should be checked for existance
277 bool auto_reset_options;
279 bool check_lastfiles;
280 /// maximal number of lastfiles
281 unsigned int num_lastfiles;
282 /// whether or not go to saved position when opening a file
283 bool use_lastfilepos;
284 /// load files from last session automatically
286 /// do we save new documents as compressed by default
287 bool save_compressed;
288 /// whether or not to save the document dir in the file
290 /// shall a backup file be created
292 /// A directory for storing backup files
293 std::string backupdir_path;
294 /// Whether or not save/restore session information
295 /// like windows position and geometry.
296 bool allow_geometry_session;
297 /// Scrolling speed of the mouse wheel
298 double mouse_wheel_speed;
299 /// Default zoom factor for screen fonts
301 /// Actual zoom factor for screen fonts
302 /// (default zoom plus buffer zoom factor)
304 /// Screen font sizes in points for each font size
305 std::string font_sizes[10];
306 /// Allow the use of scalable fonts? Default is yes.
307 bool use_scalable_fonts;
311 std::string roman_font_name;
313 std::string sans_font_name;
315 std::string typewriter_font_name;
317 std::string roman_font_foundry;
319 std::string sans_font_foundry;
321 std::string typewriter_font_foundry;
323 unsigned int autosave;
325 unsigned int plaintext_linelen;
326 /// Accept compound words in spellchecker?
327 bool spellchecker_accept_compound;
328 /// End of paragraph markers?
329 bool paragraph_markers;
332 /// Use the colors from current system theme?
333 bool use_system_colors;
334 /// use native file dialog or our own ?
335 bool use_native_filedialog;
336 /// Use pixmap cache?
337 bool use_pixmap_cache;
338 /// Spellchecker engine: aspell, hunspell, etc
339 std::string spellchecker;
340 /// Alternate language for spellchecker
341 std::string spellchecker_alt_lang;
342 /// Escape characters
343 std::string spellchecker_esc_chars;
344 /// spellcheck continuously?
345 bool spellcheck_continuously;
346 /// spellcheck notes and comments?
347 bool spellcheck_notes;
348 /// minimum length of words to complete
349 unsigned int completion_minlength;
353 std::string primary_kbmap;
355 std::string secondary_kbmap;
357 std::string lyxpipes;
359 std::string language_custom_package;
361 bool language_auto_begin;
363 bool language_auto_end;
365 std::string language_command_begin;
367 std::string language_command_end;
369 std::string language_command_local;
371 bool language_global_options;
373 enum LangPackageSelection {
380 LangPackageSelection language_package_selection;
381 /// bidi cursor movement: true = visual, false = logical
386 bool mark_foreign_language;
388 std::string gui_language;
390 std::string default_otf_view_format;
392 std::string default_platex_view_format;
394 std::string default_view_format;
395 /// all available viewers
396 Alternatives viewer_alternatives;
397 /// all available editors
398 Alternatives editor_alternatives;
400 bool mac_dontswap_ctrl_meta;
402 bool mac_like_cursor_movement;
404 bool cursor_follows_scrollbar;
406 bool scroll_below_document;
408 enum MacroEditStyle {
409 MACRO_EDIT_INLINE_BOX = 0,
414 MacroEditStyle macro_edit_style;
416 bool dialogs_iconify_with_main;
418 bool display_graphics;
428 PreviewStatus preview;
430 bool preview_hashed_labels;
432 double preview_scale_factor;
434 std::string user_name;
436 std::string user_email;
438 std::string icon_set;
439 /// whether to use the icons from the theme
440 bool use_system_theme_icons;
441 /// True if the TeX engine cannot handle posix paths
442 bool windows_style_tex_paths;
443 /// True if the TeX engine can handle file names containing spaces
444 bool tex_allows_spaces;
445 /** Prepend paths to the PATH environment variable.
446 * The string is input, stored and output in native format.
448 std::string path_prefix;
449 /** Prepend paths to the TEXINPUTS environment variable.
450 * The string is input, stored and output in native format.
451 * A '.' here stands for the current document directory.
453 std::string texinputs_prefix;
454 /// Use the cache for file converters?
455 bool use_converter_cache;
456 /// Forbid use of external converters with 'needauth' option
457 bool use_converter_needauth_forbidden;
458 /// Ask user before calling external converters with 'needauth' option
459 bool use_converter_needauth;
460 /// The maximum age of cache files in seconds
461 unsigned int converter_cache_maxage;
462 /// Sort layouts alphabetically
464 /// Group layout by their category
466 /// Toggle toolbars in fullscreen mode?
467 bool full_screen_toolbars;
468 /// Toggle scrollbar in fullscreen mode?
469 bool full_screen_scrollbar;
470 /// Toggle tabbar in fullscreen mode?
471 bool full_screen_tabbar;
472 /// Toggle menubar in fullscreen mode?
473 bool full_screen_menubar;
474 /// Toggle statusbar in fullscreen mode?
475 bool full_screen_statusbar;
476 /// Limit the text width?
477 bool full_screen_limit;
478 /// Width of limited screen (in pixels) in fullscreen mode
479 int full_screen_width;
481 bool completion_cursor_text;
483 double completion_inline_delay;
485 bool completion_inline_math;
487 bool completion_inline_text;
489 int completion_inline_dots;
491 bool autocorrection_math;
493 double completion_popup_delay;
495 bool completion_popup_math;
497 bool completion_popup_text;
499 bool completion_popup_after_complete;
501 bool open_buffers_in_tabs;
503 bool single_close_tab_button;
505 bool single_instance;
507 std::string forward_search_dvi;
509 std::string forward_search_pdf;
511 int export_overwrite;
512 /// Default decimal point when aligning table columns on decimal
513 std::string default_decimal_point;
515 Length::UNIT default_length_unit;
517 enum ScrollWheelZoom {
518 SCROLL_WHEEL_ZOOM_OFF,
519 SCROLL_WHEEL_ZOOM_CTRL,
520 SCROLL_WHEEL_ZOOM_SHIFT,
521 SCROLL_WHEEL_ZOOM_ALT
524 ScrollWheelZoom scroll_wheel_zoom;
527 /// One of: yes, no, ask
528 std::string close_buffer_with_last_view;
532 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
537 extern LyXRC system_lyxrc;
539 // used by at least frontends/qt4/GuiPref.cpp
540 const long maxlastfiles = 50;