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_LIKE_WORD_MOVEMENT,
115 RC_MARK_FOREIGN_LANGUAGE,
116 RC_MOUSE_WHEEL_SPEED,
119 RC_OPEN_BUFFERS_IN_TABS,
120 RC_PARAGRAPH_MARKERS,
123 RC_PLAINTEXT_LINELEN,
124 RC_PLAINTEXT_ROFF_COMMAND,
126 RC_PREVIEW_HASHED_LABELS,
127 RC_PREVIEW_SCALE_FACTOR,
128 RC_PRINTCOLLCOPIESFLAG,
131 RC_PRINTEVENPAGEFLAG,
132 RC_PRINTEXSTRAOPTIONS,
133 RC_PRINTFILEEXTENSION,
134 RC_PRINTLANDSCAPEFLAG,
136 RC_PRINTPAGERANGEFLAG,
137 RC_PRINTPAPERDIMENSIONFLAG,
140 RC_PRINTSPOOL_COMMAND,
141 RC_PRINTSPOOL_PRINTERPREFIX,
144 RC_PRINT_ADAPTOUTPUT,
149 RC_SCREEN_FONT_ROMAN,
150 RC_SCREEN_FONT_ROMAN_FOUNDRY,
152 RC_SCREEN_FONT_SANS_FOUNDRY,
153 RC_SCREEN_FONT_SCALABLE,
154 RC_SCREEN_FONT_SIZES,
155 RC_SCREEN_FONT_TYPEWRITER,
156 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
158 RC_SCROLL_BELOW_DOCUMENT,
159 RC_SCROLL_WHEEL_ZOOM,
163 RC_SINGLE_CLOSE_TAB_BUTTON,
166 RC_SPELLCHECK_CONTINUOUSLY,
169 RC_SPLITINDEX_COMMAND,
172 RC_TEX_ALLOWS_SPACES,
173 RC_TEX_EXPECTS_WINDOWS_PATHS,
181 RC_USE_CONVERTER_CACHE,
188 RC_VIEWDVI_PAPEROPTION,
190 RC_VIEWER_ALTERNATIVES,
200 int read(support::FileName const & filename);
202 int read(std::istream &);
208 typedef std::set<std::string> CommandSet;
209 /// maps a format to a set of commands that can be used to
211 typedef std::map<std::string, CommandSet> Alternatives;
213 void write(support::FileName const & filename,
214 bool ignore_system_lyxrc) const;
215 /// write rc. If a specific tag is given, only output that one.
216 void write(std::ostream & os,
217 bool ignore_system_lyxrc,
218 std::string const & tag = std::string()) const;
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;
232 std::string print_command;
234 std::string print_evenpage_flag;
236 std::string print_oddpage_flag;
238 std::string print_pagerange_flag;
240 std::string print_copies_flag;
242 std::string print_collcopies_flag;
244 std::string print_reverse_flag;
246 std::string print_landscape_flag;
248 std::string print_to_printer;
250 bool print_adapt_output;
252 std::string print_to_file;
254 std::string print_file_extension;
256 std::string print_extra_options;
258 std::string print_spool_command;
260 std::string print_spool_printerprefix;
262 std::string print_paper_flag;
264 std::string print_paper_dimension_flag;
265 /// option for telling the dvi viewer about the paper size
266 std::string view_dvi_paper_option;
267 /// default paper size for local xdvi/dvips/ghostview/whatever
268 PAPER_SIZE default_papersize;
269 /// command to run chktex incl. options
270 std::string chktex_command;
271 /// all available commands to run bibtex incl. options
272 CommandSet bibtex_alternatives;
273 /// command to run bibtex incl. options
274 std::string bibtex_command;
275 /// command to run japanese bibtex incl. options
276 std::string jbibtex_command;
277 /// all available index commands incl. options
278 CommandSet index_alternatives;
279 /// command to run makeindex incl. options or other index programs
280 std::string index_command;
281 /// command to run japanese index program incl. options
282 std::string jindex_command;
283 /// command to generate multiple indices
284 std::string splitindex_command;
285 /// command to run makeindex incl. options for nomencl
286 std::string nomencl_command;
288 std::string document_path;
290 std::string example_path;
292 std::string template_path;
294 std::string tempdir_path;
296 std::string thesaurusdir_path;
298 std::string hunspelldir_path;
300 bool auto_region_delete;
301 /// flag telling whether lastfiles should be checked for existance
302 bool auto_reset_options;
304 bool check_lastfiles;
305 /// maximal number of lastfiles
306 unsigned int num_lastfiles;
307 /// whether or not go to saved position when opening a file
308 bool use_lastfilepos;
309 /// load files from last session automatically
311 /// do we save new documents as compressed by default
312 bool save_compressed;
313 /// shall a backup file be created
315 /// A directory for storing backup files
316 std::string backupdir_path;
317 /// Whether or not save/restore session information
318 /// like windows position and geometry.
319 bool allow_geometry_session;
320 /// Scrolling speed of the mouse wheel
321 double mouse_wheel_speed;
322 /// Zoom factor for screen fonts
324 /// Screen font sizes in points for each font size
325 std::string font_sizes[10];
326 /// Allow the use of scalable fonts? Default is yes.
327 bool use_scalable_fonts;
333 std::string roman_font_name;
335 std::string sans_font_name;
337 std::string typewriter_font_name;
339 std::string roman_font_foundry;
341 std::string sans_font_foundry;
343 std::string typewriter_font_foundry;
345 unsigned int autosave;
347 unsigned int plaintext_linelen;
348 /// Accept compound words in spellchecker?
349 bool spellchecker_accept_compound;
350 /// End of paragraph markers?
351 bool paragraph_markers;
354 /// Use pixmap cache?
355 bool use_pixmap_cache;
356 /// Spellchecker engine: aspell, hunspell, etc
357 std::string spellchecker;
358 /// Alternate language for spellchecker
359 std::string spellchecker_alt_lang;
360 /// Escape characters
361 std::string spellchecker_esc_chars;
362 /// spellcheck continuously?
363 bool spellcheck_continuously;
364 /// spellcheck notes and comments?
365 bool spellcheck_notes;
369 std::string primary_kbmap;
371 std::string secondary_kbmap;
373 std::string lyxpipes;
375 std::string date_insert_format;
377 std::string language_package;
379 bool language_auto_begin;
381 bool language_auto_end;
383 std::string language_command_begin;
385 std::string language_command_end;
387 std::string language_command_local;
389 bool language_global_options;
391 bool language_use_babel;
394 /// bidi cursor movement: true = visual, false = logical
399 bool mark_foreign_language;
401 std::string default_language;
403 std::string gui_language;
405 std::string default_view_format;
406 /// all available viewers
407 Alternatives viewer_alternatives;
408 /// all available editors
409 Alternatives editor_alternatives;
411 bool mac_like_word_movement;
413 bool cursor_follows_scrollbar;
415 bool scroll_below_document;
417 enum MacroEditStyle {
418 MACRO_EDIT_INLINE_BOX = 0,
423 MacroEditStyle macro_edit_style;
425 bool dialogs_iconify_with_main;
427 bool display_graphics;
437 PreviewStatus preview;
439 bool preview_hashed_labels;
441 double preview_scale_factor;
443 std::string user_name;
445 std::string user_email;
446 /// True if the TeX engine cannot handle posix paths
447 bool windows_style_tex_paths;
448 /// True if the TeX engine can handle file names containing spaces
449 bool tex_allows_spaces;
450 /** Prepend paths to the PATH environment variable.
451 * The string is input, stored and output in native format.
453 std::string path_prefix;
454 /// Use the cache for file converters?
455 bool use_converter_cache;
456 /// The maximum age of cache files in seconds
457 unsigned int converter_cache_maxage;
458 /// Sort layouts alphabetically
460 /// Group layout by their category
462 /// Toggle toolbars in fullscreen mode?
463 bool full_screen_toolbars;
464 /// Toggle scrollbar in fullscreen mode?
465 bool full_screen_scrollbar;
466 /// Toggle tabbar in fullscreen mode?
467 bool full_screen_tabbar;
468 /// Toggle menubar in fullscreen mode?
469 bool full_screen_menubar;
470 /// Limit the text width?
471 bool full_screen_limit;
472 /// Width of limited screen (in pixels) in fullscreen mode
473 int full_screen_width;
475 bool completion_cursor_text;
477 double completion_inline_delay;
479 bool completion_inline_math;
481 bool completion_inline_text;
483 int completion_inline_dots;
485 bool autocorrection_math;
487 double completion_popup_delay;
489 bool completion_popup_math;
491 bool completion_popup_text;
493 bool completion_popup_after_complete;
495 bool open_buffers_in_tabs;
497 bool single_close_tab_button;
499 std::string forward_search_dvi;
501 std::string forward_search_pdf;
503 int export_overwrite;
504 /// Default decimal point when aligning table columns on decimal
505 std::string default_decimal_point;
507 enum ScrollWheelZoom {
508 SCROLL_WHEEL_ZOOM_OFF,
509 SCROLL_WHEEL_ZOOM_CTRL,
510 SCROLL_WHEEL_ZOOM_SHIFT,
511 SCROLL_WHEEL_ZOOM_OPTION
514 ScrollWheelZoom scroll_whell_zoom;
518 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
519 * It can be forward-declared and passed as a function argument without
520 * having to expose LyXRC.h.
522 class LyXRC_PreviewStatus {
523 LyXRC::PreviewStatus val_;
525 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
526 operator LyXRC::PreviewStatus() const { return val_; }
529 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
534 extern LyXRC system_lyxrc;
536 // used by at least frontends/qt4/GuiPref.cpp
537 const long maxlastfiles = 20;