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"
33 namespace support { class FileName; }
37 /// This contains the runtime configuration of LyX
42 RC_ACCEPT_COMPOUND = 1,
44 RC_AUTOCORRECTION_MATH,
50 RC_BIBTEX_ALTERNATIVES,
55 RC_COMPLETION_CURSOR_TEXT,
56 RC_COMPLETION_INLINE_DELAY,
57 RC_COMPLETION_INLINE_MATH,
58 RC_COMPLETION_INLINE_TEXT,
59 RC_COMPLETION_INLINE_DOTS,
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,
68 RC_DATE_INSERT_FORMAT,
69 RC_DEFAULT_DECIMAL_POINT,
71 RC_DEFAULT_VIEW_FORMAT,
74 RC_DIALOGS_ICONIFY_WITH_MAIN,
77 RC_EDITOR_ALTERNATIVES,
83 RC_FORWARD_SEARCH_DVI,
84 RC_FORWARD_SEARCH_PDF,
86 RC_FULL_SCREEN_SCROLLBAR,
87 RC_FULL_SCREEN_TABBAR,
88 RC_FULL_SCREEN_MENUBAR,
89 RC_FULL_SCREEN_TOOLBARS,
95 RC_INDEX_ALTERNATIVES,
103 RC_LANGUAGE_AUTO_BEGIN,
104 RC_LANGUAGE_AUTO_END,
105 RC_LANGUAGE_COMMAND_BEGIN,
106 RC_LANGUAGE_COMMAND_END,
107 RC_LANGUAGE_COMMAND_LOCAL,
108 RC_LANGUAGE_GLOBAL_OPTIONS,
110 RC_LANGUAGE_USE_BABEL,
113 RC_MAC_DONTSWAP_CTRL_META,
114 RC_MAC_LIKE_WORD_MOVEMENT,
116 RC_MARK_FOREIGN_LANGUAGE,
117 RC_MOUSE_WHEEL_SPEED,
120 RC_OPEN_BUFFERS_IN_TABS,
121 RC_PARAGRAPH_MARKERS,
124 RC_PLAINTEXT_LINELEN,
125 RC_PLAINTEXT_ROFF_COMMAND,
127 RC_PREVIEW_HASHED_LABELS,
128 RC_PREVIEW_SCALE_FACTOR,
129 RC_PRINTCOLLCOPIESFLAG,
132 RC_PRINTEVENPAGEFLAG,
133 RC_PRINTEXSTRAOPTIONS,
134 RC_PRINTFILEEXTENSION,
135 RC_PRINTLANDSCAPEFLAG,
137 RC_PRINTPAGERANGEFLAG,
138 RC_PRINTPAPERDIMENSIONFLAG,
141 RC_PRINTSPOOL_COMMAND,
142 RC_PRINTSPOOL_PRINTERPREFIX,
145 RC_PRINT_ADAPTOUTPUT,
150 RC_SCREEN_FONT_ROMAN,
151 RC_SCREEN_FONT_ROMAN_FOUNDRY,
153 RC_SCREEN_FONT_SANS_FOUNDRY,
154 RC_SCREEN_FONT_SCALABLE,
155 RC_SCREEN_FONT_SIZES,
156 RC_SCREEN_FONT_TYPEWRITER,
157 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
159 RC_SCROLL_BELOW_DOCUMENT,
160 RC_SCROLL_WHEEL_ZOOM,
164 RC_SINGLE_CLOSE_TAB_BUTTON,
167 RC_SPELLCHECK_CONTINUOUSLY,
170 RC_SPLITINDEX_COMMAND,
173 RC_TEX_ALLOWS_SPACES,
174 RC_TEX_EXPECTS_WINDOWS_PATHS,
182 RC_USE_CONVERTER_CACHE,
186 RC_USE_SYSTEM_COLORS,
190 RC_VIEWDVI_PAPEROPTION,
192 RC_VIEWER_ALTERNATIVES,
202 int read(support::FileName const & filename);
204 int read(std::istream &);
210 typedef std::set<std::string> CommandSet;
211 /// maps a format to a set of commands that can be used to
213 typedef std::map<std::string, CommandSet> Alternatives;
215 void write(support::FileName const & filename,
216 bool ignore_system_lyxrc) const;
217 /// write rc. If a specific tag is given, only output that one.
218 void write(std::ostream & os,
219 bool ignore_system_lyxrc,
220 std::string const & tag = std::string()) const;
223 // FIXME unused (was used for xforms. Do we still need this?)
224 //static docstring const getDescription(LyXRCTags);
226 std::string bind_file;
228 std::string def_file;
234 std::string print_command;
236 std::string print_evenpage_flag;
238 std::string print_oddpage_flag;
240 std::string print_pagerange_flag;
242 std::string print_copies_flag;
244 std::string print_collcopies_flag;
246 std::string print_reverse_flag;
248 std::string print_landscape_flag;
250 std::string print_to_printer;
252 bool print_adapt_output;
254 std::string print_to_file;
256 std::string print_file_extension;
258 std::string print_extra_options;
260 std::string print_spool_command;
262 std::string print_spool_printerprefix;
264 std::string print_paper_flag;
266 std::string print_paper_dimension_flag;
267 /// option for telling the dvi viewer about the paper size
268 std::string view_dvi_paper_option;
269 /// default paper size for local xdvi/dvips/ghostview/whatever
270 PAPER_SIZE default_papersize;
271 /// command to run chktex incl. options
272 std::string chktex_command;
273 /// all available commands to run bibtex incl. options
274 CommandSet bibtex_alternatives;
275 /// command to run bibtex incl. options
276 std::string bibtex_command;
277 /// command to run japanese bibtex incl. options
278 std::string jbibtex_command;
279 /// all available index commands incl. options
280 CommandSet index_alternatives;
281 /// command to run makeindex incl. options or other index programs
282 std::string index_command;
283 /// command to run japanese index program incl. options
284 std::string jindex_command;
285 /// command to generate multiple indices
286 std::string splitindex_command;
287 /// command to run makeindex incl. options for nomencl
288 std::string nomencl_command;
290 std::string document_path;
292 std::string example_path;
294 std::string template_path;
296 std::string tempdir_path;
298 std::string thesaurusdir_path;
300 std::string hunspelldir_path;
302 bool auto_region_delete;
303 /// flag telling whether lastfiles should be checked for existance
304 bool auto_reset_options;
306 bool check_lastfiles;
307 /// maximal number of lastfiles
308 unsigned int num_lastfiles;
309 /// whether or not go to saved position when opening a file
310 bool use_lastfilepos;
311 /// load files from last session automatically
313 /// do we save new documents as compressed by default
314 bool save_compressed;
315 /// shall a backup file be created
317 /// A directory for storing backup files
318 std::string backupdir_path;
319 /// Whether or not save/restore session information
320 /// like windows position and geometry.
321 bool allow_geometry_session;
322 /// Scrolling speed of the mouse wheel
323 double mouse_wheel_speed;
324 /// Zoom factor for screen fonts
326 /// Screen font sizes in points for each font size
327 std::string font_sizes[10];
328 /// Allow the use of scalable fonts? Default is yes.
329 bool use_scalable_fonts;
335 std::string roman_font_name;
337 std::string sans_font_name;
339 std::string typewriter_font_name;
341 std::string roman_font_foundry;
343 std::string sans_font_foundry;
345 std::string typewriter_font_foundry;
347 unsigned int autosave;
349 unsigned int plaintext_linelen;
350 /// Accept compound words in spellchecker?
351 bool spellchecker_accept_compound;
352 /// End of paragraph markers?
353 bool paragraph_markers;
356 /// Use the colors from current system theme?
357 bool use_system_colors;
358 /// Use pixmap cache?
359 bool use_pixmap_cache;
360 /// Spellchecker engine: aspell, hunspell, etc
361 std::string spellchecker;
362 /// Alternate language for spellchecker
363 std::string spellchecker_alt_lang;
364 /// Escape characters
365 std::string spellchecker_esc_chars;
366 /// spellcheck continuously?
367 bool spellcheck_continuously;
368 /// spellcheck notes and comments?
369 bool spellcheck_notes;
373 std::string primary_kbmap;
375 std::string secondary_kbmap;
377 std::string lyxpipes;
379 std::string date_insert_format;
381 std::string language_package;
383 bool language_auto_begin;
385 bool language_auto_end;
387 std::string language_command_begin;
389 std::string language_command_end;
391 std::string language_command_local;
393 bool language_global_options;
395 bool language_use_babel;
398 /// bidi cursor movement: true = visual, false = logical
403 bool mark_foreign_language;
405 std::string default_language;
407 std::string gui_language;
409 std::string default_view_format;
410 /// all available viewers
411 Alternatives viewer_alternatives;
412 /// all available editors
413 Alternatives editor_alternatives;
415 bool mac_dontswap_ctrl_meta;
417 bool mac_like_word_movement;
419 bool cursor_follows_scrollbar;
421 bool scroll_below_document;
423 enum MacroEditStyle {
424 MACRO_EDIT_INLINE_BOX = 0,
429 MacroEditStyle macro_edit_style;
431 bool dialogs_iconify_with_main;
433 bool display_graphics;
443 PreviewStatus preview;
445 bool preview_hashed_labels;
447 double preview_scale_factor;
449 std::string user_name;
451 std::string user_email;
452 /// True if the TeX engine cannot handle posix paths
453 bool windows_style_tex_paths;
454 /// True if the TeX engine can handle file names containing spaces
455 bool tex_allows_spaces;
456 /** Prepend paths to the PATH environment variable.
457 * The string is input, stored and output in native format.
459 std::string path_prefix;
460 /// Use the cache for file converters?
461 bool use_converter_cache;
462 /// The maximum age of cache files in seconds
463 unsigned int converter_cache_maxage;
464 /// Sort layouts alphabetically
466 /// Group layout by their category
468 /// Toggle toolbars in fullscreen mode?
469 bool full_screen_toolbars;
470 /// Toggle scrollbar in fullscreen mode?
471 bool full_screen_scrollbar;
472 /// Toggle tabbar in fullscreen mode?
473 bool full_screen_tabbar;
474 /// Toggle menubar in fullscreen mode?
475 bool full_screen_menubar;
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 std::string forward_search_dvi;
507 std::string forward_search_pdf;
509 int export_overwrite;
510 /// Default decimal point when aligning table columns on decimal
511 std::string default_decimal_point;
513 enum ScrollWheelZoom {
514 SCROLL_WHEEL_ZOOM_OFF,
515 SCROLL_WHEEL_ZOOM_CTRL,
516 SCROLL_WHEEL_ZOOM_SHIFT,
517 SCROLL_WHEEL_ZOOM_ALT
520 ScrollWheelZoom scroll_wheel_zoom;
524 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
525 * It can be forward-declared and passed as a function argument without
526 * having to expose LyXRC.h.
528 class LyXRC_PreviewStatus {
529 LyXRC::PreviewStatus val_;
531 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
532 operator LyXRC::PreviewStatus() const { return val_; }
535 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
540 extern LyXRC system_lyxrc;
542 // used by at least frontends/qt4/GuiPref.cpp
543 const long maxlastfiles = 20;