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,
70 RC_DEFAULT_VIEW_FORMAT,
73 RC_DIALOGS_ICONIFY_WITH_MAIN,
76 RC_EDITOR_ALTERNATIVES,
82 RC_FULL_SCREEN_SCROLLBAR,
83 RC_FULL_SCREEN_TABBAR,
84 RC_FULL_SCREEN_MENUBAR,
85 RC_FULL_SCREEN_TOOLBARS,
91 RC_INDEX_ALTERNATIVES,
99 RC_LANGUAGE_AUTO_BEGIN,
100 RC_LANGUAGE_AUTO_END,
101 RC_LANGUAGE_COMMAND_BEGIN,
102 RC_LANGUAGE_COMMAND_END,
103 RC_LANGUAGE_COMMAND_LOCAL,
104 RC_LANGUAGE_GLOBAL_OPTIONS,
106 RC_LANGUAGE_USE_BABEL,
109 RC_MAC_LIKE_WORD_MOVEMENT,
111 RC_MARK_FOREIGN_LANGUAGE,
112 RC_MOUSE_WHEEL_SPEED,
115 RC_OPEN_BUFFERS_IN_TABS,
116 RC_PARAGRAPH_MARKERS,
119 RC_PLAINTEXT_LINELEN,
120 RC_PLAINTEXT_ROFF_COMMAND,
122 RC_PREVIEW_HASHED_LABELS,
123 RC_PREVIEW_SCALE_FACTOR,
124 RC_PRINTCOLLCOPIESFLAG,
127 RC_PRINTEVENPAGEFLAG,
128 RC_PRINTEXSTRAOPTIONS,
129 RC_PRINTFILEEXTENSION,
130 RC_PRINTLANDSCAPEFLAG,
132 RC_PRINTPAGERANGEFLAG,
133 RC_PRINTPAPERDIMENSIONFLAG,
136 RC_PRINTSPOOL_COMMAND,
137 RC_PRINTSPOOL_PRINTERPREFIX,
140 RC_PRINT_ADAPTOUTPUT,
144 RC_SCREEN_FONT_ROMAN,
145 RC_SCREEN_FONT_ROMAN_FOUNDRY,
147 RC_SCREEN_FONT_SANS_FOUNDRY,
148 RC_SCREEN_FONT_SCALABLE,
149 RC_SCREEN_FONT_SIZES,
150 RC_SCREEN_FONT_TYPEWRITER,
151 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
153 RC_SCROLL_BELOW_DOCUMENT,
157 RC_SINGLE_CLOSE_TAB_BUTTON,
160 RC_SPELLCHECK_CONTINUOUSLY,
163 RC_SPLITINDEX_COMMAND,
166 RC_TEX_ALLOWS_SPACES,
167 RC_TEX_EXPECTS_WINDOWS_PATHS,
175 RC_USE_CONVERTER_CACHE,
182 RC_VIEWDVI_PAPEROPTION,
184 RC_VIEWER_ALTERNATIVES,
194 int read(support::FileName const & filename);
196 int read(std::istream &);
202 typedef std::set<std::string> CommandSet;
203 /// maps a format to a set of commands that can be used to
205 typedef std::map<std::string, CommandSet> Alternatives;
207 void write(support::FileName const & filename,
208 bool ignore_system_lyxrc) const;
209 /// write rc. If a specific tag is given, only output that one.
210 void write(std::ostream & os,
211 bool ignore_system_lyxrc,
212 std::string const & tag = std::string()) const;
215 // FIXME unused (was used for xforms. Do we still need this?)
216 //static docstring const getDescription(LyXRCTags);
218 std::string bind_file;
220 std::string def_file;
226 std::string print_command;
228 std::string print_evenpage_flag;
230 std::string print_oddpage_flag;
232 std::string print_pagerange_flag;
234 std::string print_copies_flag;
236 std::string print_collcopies_flag;
238 std::string print_reverse_flag;
240 std::string print_landscape_flag;
242 std::string print_to_printer;
244 bool print_adapt_output;
246 std::string print_to_file;
248 std::string print_file_extension;
250 std::string print_extra_options;
252 std::string print_spool_command;
254 std::string print_spool_printerprefix;
256 std::string print_paper_flag;
258 std::string print_paper_dimension_flag;
259 /// option for telling the dvi viewer about the paper size
260 std::string view_dvi_paper_option;
261 /// default paper size for local xdvi/dvips/ghostview/whatever
262 PAPER_SIZE default_papersize;
263 /// command to run chktex incl. options
264 std::string chktex_command;
265 /// all available commands to run bibtex incl. options
266 CommandSet bibtex_alternatives;
267 /// command to run bibtex incl. options
268 std::string bibtex_command;
269 /// command to run japanese bibtex incl. options
270 std::string jbibtex_command;
271 /// all available index commands incl. options
272 CommandSet index_alternatives;
273 /// command to run makeindex incl. options or other index programs
274 std::string index_command;
275 /// command to run japanese index program incl. options
276 std::string jindex_command;
277 /// command to generate multiple indices
278 std::string splitindex_command;
279 /// command to run makeindex incl. options for nomencl
280 std::string nomencl_command;
282 std::string document_path;
284 std::string example_path;
286 std::string template_path;
288 std::string tempdir_path;
290 std::string thesaurusdir_path;
292 std::string hunspelldir_path;
294 bool auto_region_delete;
295 /// flag telling whether lastfiles should be checked for existance
296 bool auto_reset_options;
298 bool check_lastfiles;
299 /// maximal number of lastfiles
300 unsigned int num_lastfiles;
301 /// whether or not go to saved position when opening a file
302 bool use_lastfilepos;
303 /// load files from last session automatically
305 /// shall a backup file be created
307 /// A directory for storing backup files
308 std::string backupdir_path;
309 /// Whether or not save/restore session information
310 /// like windows position and geometry.
311 bool allow_geometry_session;
312 /// Scrolling speed of the mouse wheel
313 double mouse_wheel_speed;
314 /// Zoom factor for screen fonts
316 /// Screen font sizes in points for each font size
317 std::string font_sizes[10];
318 /// Allow the use of scalable fonts? Default is yes.
319 bool use_scalable_fonts;
325 std::string roman_font_name;
327 std::string sans_font_name;
329 std::string typewriter_font_name;
331 std::string roman_font_foundry;
333 std::string sans_font_foundry;
335 std::string typewriter_font_foundry;
337 unsigned int autosave;
339 unsigned int plaintext_linelen;
340 /// Accept compound words in spellchecker?
341 bool spellchecker_accept_compound;
342 /// End of paragraph markers?
343 bool paragraph_markers;
346 /// Use pixmap cache?
347 bool use_pixmap_cache;
348 /// Spellchecker engine: aspell, hunspell, etc
349 std::string spellchecker;
350 /// Alternate language for spellchecker
351 std::string spellchecker_alt_lang;
352 /// Escape characters
353 std::string spellchecker_esc_chars;
354 /// spellcheck continuously?
355 bool spellcheck_continuously;
356 /// spellcheck notes and comments?
357 bool spellcheck_notes;
361 std::string primary_kbmap;
363 std::string secondary_kbmap;
365 std::string lyxpipes;
367 std::string date_insert_format;
369 std::string language_package;
371 bool language_auto_begin;
373 bool language_auto_end;
375 std::string language_command_begin;
377 std::string language_command_end;
379 std::string language_command_local;
381 bool language_global_options;
383 bool language_use_babel;
386 /// bidi cursor movement: true = visual, false = logical
391 bool mark_foreign_language;
393 std::string default_language;
395 std::string gui_language;
397 std::string default_view_format;
398 /// all available viewers
399 Alternatives viewer_alternatives;
400 /// all available editors
401 Alternatives editor_alternatives;
403 bool mac_like_word_movement;
405 bool cursor_follows_scrollbar;
407 bool scroll_below_document;
409 enum MacroEditStyle {
410 MACRO_EDIT_INLINE_BOX = 0,
415 MacroEditStyle macro_edit_style;
417 bool dialogs_iconify_with_main;
419 bool display_graphics;
429 PreviewStatus preview;
431 bool preview_hashed_labels;
433 double preview_scale_factor;
435 std::string user_name;
437 std::string user_email;
438 /// True if the TeX engine cannot handle posix paths
439 bool windows_style_tex_paths;
440 /// True if the TeX engine can handle file names containing spaces
441 bool tex_allows_spaces;
442 /** Prepend paths to the PATH environment variable.
443 * The string is input, stored and output in native format.
445 std::string path_prefix;
446 /// Use the cache for file converters?
447 bool use_converter_cache;
448 /// The maximum age of cache files in seconds
449 unsigned int converter_cache_maxage;
450 /// Sort layouts alphabetically
452 /// Group layout by their category
454 /// Toggle toolbars in fullscreen mode?
455 bool full_screen_toolbars;
456 /// Toggle scrollbar in fullscreen mode?
457 bool full_screen_scrollbar;
458 /// Toggle tabbar in fullscreen mode?
459 bool full_screen_tabbar;
460 /// Toggle menubar in fullscreen mode?
461 bool full_screen_menubar;
462 /// Limit the text width?
463 bool full_screen_limit;
464 /// Width of limited screen (in pixels) in fullscreen mode
465 int full_screen_width;
467 bool completion_cursor_text;
469 double completion_inline_delay;
471 bool completion_inline_math;
473 bool completion_inline_text;
475 int completion_inline_dots;
477 bool autocorrection_math;
479 double completion_popup_delay;
481 bool completion_popup_math;
483 bool completion_popup_text;
485 bool completion_popup_after_complete;
487 bool open_buffers_in_tabs;
489 bool single_close_tab_button;
493 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
494 * It can be forward-declared and passed as a function argument without
495 * having to expose LyXRC.h.
497 class LyXRC_PreviewStatus {
498 LyXRC::PreviewStatus val_;
500 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
501 operator LyXRC::PreviewStatus() const { return val_; }
504 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
509 extern LyXRC system_lyxrc;
511 // used by at least frontends/qt4/GuiPref.cpp
512 const long maxlastfiles = 20;