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,
185 RC_USE_SYSTEM_COLORS,
189 RC_VIEWDVI_PAPEROPTION,
191 RC_VIEWER_ALTERNATIVES,
201 int read(support::FileName const & filename);
203 int read(std::istream &);
209 typedef std::set<std::string> CommandSet;
210 /// maps a format to a set of commands that can be used to
212 typedef std::map<std::string, CommandSet> Alternatives;
214 void write(support::FileName const & filename,
215 bool ignore_system_lyxrc) const;
216 /// write rc. If a specific tag is given, only output that one.
217 void write(std::ostream & os,
218 bool ignore_system_lyxrc,
219 std::string const & tag = std::string()) const;
222 // FIXME unused (was used for xforms. Do we still need this?)
223 //static docstring const getDescription(LyXRCTags);
225 std::string bind_file;
227 std::string def_file;
233 std::string print_command;
235 std::string print_evenpage_flag;
237 std::string print_oddpage_flag;
239 std::string print_pagerange_flag;
241 std::string print_copies_flag;
243 std::string print_collcopies_flag;
245 std::string print_reverse_flag;
247 std::string print_landscape_flag;
249 std::string print_to_printer;
251 bool print_adapt_output;
253 std::string print_to_file;
255 std::string print_file_extension;
257 std::string print_extra_options;
259 std::string print_spool_command;
261 std::string print_spool_printerprefix;
263 std::string print_paper_flag;
265 std::string print_paper_dimension_flag;
266 /// option for telling the dvi viewer about the paper size
267 std::string view_dvi_paper_option;
268 /// default paper size for local xdvi/dvips/ghostview/whatever
269 PAPER_SIZE default_papersize;
270 /// command to run chktex incl. options
271 std::string chktex_command;
272 /// all available commands to run bibtex incl. options
273 CommandSet bibtex_alternatives;
274 /// command to run bibtex incl. options
275 std::string bibtex_command;
276 /// command to run japanese bibtex incl. options
277 std::string jbibtex_command;
278 /// all available index commands incl. options
279 CommandSet index_alternatives;
280 /// command to run makeindex incl. options or other index programs
281 std::string index_command;
282 /// command to run japanese index program incl. options
283 std::string jindex_command;
284 /// command to generate multiple indices
285 std::string splitindex_command;
286 /// command to run makeindex incl. options for nomencl
287 std::string nomencl_command;
289 std::string document_path;
291 std::string example_path;
293 std::string template_path;
295 std::string tempdir_path;
297 std::string thesaurusdir_path;
299 std::string hunspelldir_path;
301 bool auto_region_delete;
302 /// flag telling whether lastfiles should be checked for existance
303 bool auto_reset_options;
305 bool check_lastfiles;
306 /// maximal number of lastfiles
307 unsigned int num_lastfiles;
308 /// whether or not go to saved position when opening a file
309 bool use_lastfilepos;
310 /// load files from last session automatically
312 /// do we save new documents as compressed by default
313 bool save_compressed;
314 /// shall a backup file be created
316 /// A directory for storing backup files
317 std::string backupdir_path;
318 /// Whether or not save/restore session information
319 /// like windows position and geometry.
320 bool allow_geometry_session;
321 /// Scrolling speed of the mouse wheel
322 double mouse_wheel_speed;
323 /// Zoom factor for screen fonts
325 /// Screen font sizes in points for each font size
326 std::string font_sizes[10];
327 /// Allow the use of scalable fonts? Default is yes.
328 bool use_scalable_fonts;
334 std::string roman_font_name;
336 std::string sans_font_name;
338 std::string typewriter_font_name;
340 std::string roman_font_foundry;
342 std::string sans_font_foundry;
344 std::string typewriter_font_foundry;
346 unsigned int autosave;
348 unsigned int plaintext_linelen;
349 /// Accept compound words in spellchecker?
350 bool spellchecker_accept_compound;
351 /// End of paragraph markers?
352 bool paragraph_markers;
355 /// Use the colors from current system theme?
356 bool use_system_colors;
357 /// Use pixmap cache?
358 bool use_pixmap_cache;
359 /// Spellchecker engine: aspell, hunspell, etc
360 std::string spellchecker;
361 /// Alternate language for spellchecker
362 std::string spellchecker_alt_lang;
363 /// Escape characters
364 std::string spellchecker_esc_chars;
365 /// spellcheck continuously?
366 bool spellcheck_continuously;
367 /// spellcheck notes and comments?
368 bool spellcheck_notes;
372 std::string primary_kbmap;
374 std::string secondary_kbmap;
376 std::string lyxpipes;
378 std::string date_insert_format;
380 std::string language_package;
382 bool language_auto_begin;
384 bool language_auto_end;
386 std::string language_command_begin;
388 std::string language_command_end;
390 std::string language_command_local;
392 bool language_global_options;
394 bool language_use_babel;
397 /// bidi cursor movement: true = visual, false = logical
402 bool mark_foreign_language;
404 std::string default_language;
406 std::string gui_language;
408 std::string default_view_format;
409 /// all available viewers
410 Alternatives viewer_alternatives;
411 /// all available editors
412 Alternatives editor_alternatives;
414 bool mac_like_word_movement;
416 bool cursor_follows_scrollbar;
418 bool scroll_below_document;
420 enum MacroEditStyle {
421 MACRO_EDIT_INLINE_BOX = 0,
426 MacroEditStyle macro_edit_style;
428 bool dialogs_iconify_with_main;
430 bool display_graphics;
440 PreviewStatus preview;
442 bool preview_hashed_labels;
444 double preview_scale_factor;
446 std::string user_name;
448 std::string user_email;
449 /// True if the TeX engine cannot handle posix paths
450 bool windows_style_tex_paths;
451 /// True if the TeX engine can handle file names containing spaces
452 bool tex_allows_spaces;
453 /** Prepend paths to the PATH environment variable.
454 * The string is input, stored and output in native format.
456 std::string path_prefix;
457 /// Use the cache for file converters?
458 bool use_converter_cache;
459 /// The maximum age of cache files in seconds
460 unsigned int converter_cache_maxage;
461 /// Sort layouts alphabetically
463 /// Group layout by their category
465 /// Toggle toolbars in fullscreen mode?
466 bool full_screen_toolbars;
467 /// Toggle scrollbar in fullscreen mode?
468 bool full_screen_scrollbar;
469 /// Toggle tabbar in fullscreen mode?
470 bool full_screen_tabbar;
471 /// Toggle menubar in fullscreen mode?
472 bool full_screen_menubar;
473 /// Limit the text width?
474 bool full_screen_limit;
475 /// Width of limited screen (in pixels) in fullscreen mode
476 int full_screen_width;
478 bool completion_cursor_text;
480 double completion_inline_delay;
482 bool completion_inline_math;
484 bool completion_inline_text;
486 int completion_inline_dots;
488 bool autocorrection_math;
490 double completion_popup_delay;
492 bool completion_popup_math;
494 bool completion_popup_text;
496 bool completion_popup_after_complete;
498 bool open_buffers_in_tabs;
500 bool single_close_tab_button;
502 std::string forward_search_dvi;
504 std::string forward_search_pdf;
506 int export_overwrite;
507 /// Default decimal point when aligning table columns on decimal
508 std::string default_decimal_point;
510 enum ScrollWheelZoom {
511 SCROLL_WHEEL_ZOOM_OFF,
512 SCROLL_WHEEL_ZOOM_CTRL,
513 SCROLL_WHEEL_ZOOM_SHIFT,
514 SCROLL_WHEEL_ZOOM_ALT
517 ScrollWheelZoom scroll_wheel_zoom;
521 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
522 * It can be forward-declared and passed as a function argument without
523 * having to expose LyXRC.h.
525 class LyXRC_PreviewStatus {
526 LyXRC::PreviewStatus val_;
528 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
529 operator LyXRC::PreviewStatus() const { return val_; }
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 = 20;