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"
31 namespace support { class FileName; }
35 /// This contains the runtime configuration of LyX
40 RC_ACCEPT_COMPOUND = 1,
42 RC_AUTOCORRECTION_MATH,
48 RC_BIBTEX_ALTERNATIVES,
53 RC_COMPLETION_CURSOR_TEXT,
54 RC_COMPLETION_INLINE_DELAY,
55 RC_COMPLETION_INLINE_MATH,
56 RC_COMPLETION_INLINE_TEXT,
57 RC_COMPLETION_INLINE_DOTS,
58 RC_COMPLETION_POPUP_DELAY,
59 RC_COMPLETION_POPUP_MATH,
60 RC_COMPLETION_POPUP_TEXT,
61 RC_COMPLETION_POPUP_AFTER_COMPLETE,
63 RC_CONVERTER_CACHE_MAXAGE,
65 RC_CURSOR_FOLLOWS_SCROLLBAR,
66 RC_DATE_INSERT_FORMAT,
68 RC_DEFAULT_VIEW_FORMAT,
71 RC_DIALOGS_ICONIFY_WITH_MAIN,
79 RC_FULL_SCREEN_SCROLLBAR,
80 RC_FULL_SCREEN_TABBAR,
81 RC_FULL_SCREEN_MENUBAR,
82 RC_FULL_SCREEN_TOOLBARS,
88 RC_INDEX_ALTERNATIVES,
97 RC_LANGUAGE_AUTO_BEGIN,
99 RC_LANGUAGE_COMMAND_BEGIN,
100 RC_LANGUAGE_COMMAND_END,
101 RC_LANGUAGE_COMMAND_LOCAL,
102 RC_LANGUAGE_GLOBAL_OPTIONS,
104 RC_LANGUAGE_USE_BABEL,
107 RC_MAC_LIKE_WORD_MOVEMENT,
109 RC_MARK_FOREIGN_LANGUAGE,
110 RC_MOUSE_WHEEL_SPEED,
113 RC_OPEN_BUFFERS_IN_TABS,
114 RC_PARAGRAPH_MARKERS,
117 RC_PLAINTEXT_LINELEN,
118 RC_PLAINTEXT_ROFF_COMMAND,
120 RC_PREVIEW_HASHED_LABELS,
121 RC_PREVIEW_SCALE_FACTOR,
122 RC_PRINTCOLLCOPIESFLAG,
125 RC_PRINTEVENPAGEFLAG,
126 RC_PRINTEXSTRAOPTIONS,
127 RC_PRINTFILEEXTENSION,
128 RC_PRINTLANDSCAPEFLAG,
130 RC_PRINTPAGERANGEFLAG,
131 RC_PRINTPAPERDIMENSIONFLAG,
134 RC_PRINTSPOOL_COMMAND,
135 RC_PRINTSPOOL_PRINTERPREFIX,
138 RC_PRINT_ADAPTOUTPUT,
142 RC_SCREEN_FONT_ROMAN,
143 RC_SCREEN_FONT_ROMAN_FOUNDRY,
145 RC_SCREEN_FONT_SANS_FOUNDRY,
146 RC_SCREEN_FONT_SCALABLE,
147 RC_SCREEN_FONT_SIZES,
148 RC_SCREEN_FONT_TYPEWRITER,
149 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
151 RC_SCROLL_BELOW_DOCUMENT,
157 RC_SPELLCHECK_CONTINUOUSLY,
159 RC_SPLITINDEX_COMMAND,
162 RC_TEX_ALLOWS_SPACES,
163 RC_TEX_EXPECTS_WINDOWS_PATHS,
171 RC_USE_CONVERTER_CACHE,
178 RC_VIEWDVI_PAPEROPTION,
189 int read(support::FileName const & filename);
191 int read(std::istream &);
197 void write(support::FileName const & filename,
198 bool ignore_system_lyxrc) const;
199 /// write rc. If a specific tag is given, only output that one.
200 void write(std::ostream & os,
201 bool ignore_system_lyxrc,
202 std::string const & tag = std::string()) const;
205 // FIXME unused (was used for xforms. Do we still need this?)
206 //static docstring const getDescription(LyXRCTags);
208 std::string bind_file;
210 std::string def_file;
216 std::string print_command;
218 std::string print_evenpage_flag;
220 std::string print_oddpage_flag;
222 std::string print_pagerange_flag;
224 std::string print_copies_flag;
226 std::string print_collcopies_flag;
228 std::string print_reverse_flag;
230 std::string print_landscape_flag;
232 std::string print_to_printer;
234 bool print_adapt_output;
236 std::string print_to_file;
238 std::string print_file_extension;
240 std::string print_extra_options;
242 std::string print_spool_command;
244 std::string print_spool_printerprefix;
246 std::string print_paper_flag;
248 std::string print_paper_dimension_flag;
249 /// option for telling the dvi viewer about the paper size
250 std::string view_dvi_paper_option;
251 /// default paper size for local xdvi/dvips/ghostview/whatever
252 PAPER_SIZE default_papersize;
253 /// command to run chktex incl. options
254 std::string chktex_command;
255 /// all available commands to run bibtex incl. options
256 std::set<std::string> bibtex_alternatives;
257 /// command to run bibtex incl. options
258 std::string bibtex_command;
259 /// command to run japanese bibtex incl. options
260 std::string jbibtex_command;
261 /// all available index commands incl. options
262 std::set<std::string> index_alternatives;
263 /// command to run makeindex incl. options or other index programs
264 std::string index_command;
265 /// command to run japanese index program incl. options
266 std::string jindex_command;
267 /// command to generate multiple indices
268 std::string splitindex_command;
269 /// command to run makeindex incl. options for nomencl
270 std::string nomencl_command;
272 std::string document_path;
274 std::string example_path;
276 std::string template_path;
278 std::string tempdir_path;
280 std::string thesaurusdir_path;
282 std::string hunspelldir_path;
284 bool auto_region_delete;
285 /// flag telling whether lastfiles should be checked for existance
286 bool auto_reset_options;
288 bool check_lastfiles;
289 /// maximal number of lastfiles
290 unsigned int num_lastfiles;
291 /// whether or not go to saved position when opening a file
292 bool use_lastfilepos;
293 /// load files from last session automatically
295 /// shall a backup file be created
297 /// A directory for storing backup files
298 std::string backupdir_path;
299 /// Whether or not save/restore session information
300 /// like windows position and geometry.
301 bool allow_geometry_session;
302 /// Scrolling speed of the mouse wheel
303 double mouse_wheel_speed;
304 /// Zoom factor for screen fonts
306 /// Screen font sizes in points for each font size
307 std::string font_sizes[10];
308 /// Allow the use of scalable fonts? Default is yes.
309 bool use_scalable_fonts;
315 std::string roman_font_name;
317 std::string sans_font_name;
319 std::string typewriter_font_name;
321 std::string roman_font_foundry;
323 std::string sans_font_foundry;
325 std::string typewriter_font_foundry;
327 unsigned int autosave;
329 unsigned int plaintext_linelen;
330 /// Accept compound words in spellchecker?
331 bool spellchecker_accept_compound;
332 /// End of paragraph markers?
333 bool paragraph_markers;
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;
349 std::string primary_kbmap;
351 std::string secondary_kbmap;
353 std::string lyxpipes;
355 std::string date_insert_format;
357 std::string language_package;
359 bool language_auto_begin;
361 bool language_auto_end;
363 std::string language_command_begin;
365 std::string language_command_end;
367 std::string language_command_local;
369 bool language_global_options;
371 bool language_use_babel;
374 /// bidi cursor movement: true = visual, false = logical
379 bool mark_foreign_language;
381 std::string default_language;
383 std::string gui_language;
385 std::string default_view_format;
387 bool mac_like_word_movement;
389 bool cursor_follows_scrollbar;
391 bool scroll_below_document;
393 enum MacroEditStyle {
394 MACRO_EDIT_INLINE_BOX = 0,
399 MacroEditStyle macro_edit_style;
401 bool dialogs_iconify_with_main;
403 int label_init_length;
405 bool display_graphics;
415 PreviewStatus preview;
417 bool preview_hashed_labels;
419 std::string preview_scale_factor;
421 std::string user_name;
423 std::string user_email;
424 /// True if the TeX engine cannot handle posix paths
425 bool windows_style_tex_paths;
426 /// True if the TeX engine can handle file names containing spaces
427 bool tex_allows_spaces;
428 /** Prepend paths to the PATH environment variable.
429 * The string is input, stored and output in native format.
431 std::string path_prefix;
432 /// Use the cache for file converters?
433 bool use_converter_cache;
434 /// The maximum age of cache files in seconds
435 unsigned int converter_cache_maxage;
436 /// Sort layouts alphabetically
438 /// Group layout by their category
440 /// Toggle toolbars in fullscreen mode?
441 bool full_screen_toolbars;
442 /// Toggle scrollbar in fullscreen mode?
443 bool full_screen_scrollbar;
444 /// Toggle tabbar in fullscreen mode?
445 bool full_screen_tabbar;
446 /// Toggle menubar in fullscreen mode?
447 bool full_screen_menubar;
448 /// Limit the text width?
449 bool full_screen_limit;
450 /// Width of limited screen (in pixels) in fullscreen mode
451 int full_screen_width;
453 bool completion_cursor_text;
455 double completion_inline_delay;
457 bool completion_inline_math;
459 bool completion_inline_text;
461 int completion_inline_dots;
463 bool autocorrection_math;
465 double completion_popup_delay;
467 bool completion_popup_math;
469 bool completion_popup_text;
471 bool completion_popup_after_complete;
473 bool open_buffers_in_tabs;
477 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
478 * It can be forward-declared and passed as a function argument without
479 * having to expose LyXRC.h.
481 class LyXRC_PreviewStatus {
482 LyXRC::PreviewStatus val_;
484 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
485 operator LyXRC::PreviewStatus() const { return val_; }
492 extern LyXRC system_lyxrc;
494 // used by at least frontends/qt4/GuiPref.cpp
495 const long maxlastfiles = 20;