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,
116 RC_PLAINTEXT_LINELEN,
117 RC_PLAINTEXT_ROFF_COMMAND,
119 RC_PREVIEW_HASHED_LABELS,
120 RC_PREVIEW_SCALE_FACTOR,
121 RC_PRINTCOLLCOPIESFLAG,
124 RC_PRINTEVENPAGEFLAG,
125 RC_PRINTEXSTRAOPTIONS,
126 RC_PRINTFILEEXTENSION,
127 RC_PRINTLANDSCAPEFLAG,
129 RC_PRINTPAGERANGEFLAG,
130 RC_PRINTPAPERDIMENSIONFLAG,
133 RC_PRINTSPOOL_COMMAND,
134 RC_PRINTSPOOL_PRINTERPREFIX,
137 RC_PRINT_ADAPTOUTPUT,
141 RC_SCREEN_FONT_ROMAN,
142 RC_SCREEN_FONT_ROMAN_FOUNDRY,
144 RC_SCREEN_FONT_SANS_FOUNDRY,
145 RC_SCREEN_FONT_SCALABLE,
146 RC_SCREEN_FONT_SIZES,
147 RC_SCREEN_FONT_TYPEWRITER,
148 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
150 RC_SCROLL_BELOW_DOCUMENT,
156 RC_SPELLCHECK_CONTINUOUSLY,
158 RC_SPLITINDEX_COMMAND,
161 RC_TEX_ALLOWS_SPACES,
162 RC_TEX_EXPECTS_WINDOWS_PATHS,
170 RC_USE_CONVERTER_CACHE,
177 RC_VIEWDVI_PAPEROPTION,
188 int read(support::FileName const & filename);
190 int read(std::istream &);
196 void write(support::FileName const & filename,
197 bool ignore_system_lyxrc) const;
198 /// write rc. If a specific tag is given, only output that one.
199 void write(std::ostream & os,
200 bool ignore_system_lyxrc,
201 std::string const & tag = std::string()) const;
204 // FIXME unused (was used for xforms. Do we still need this?)
205 //static docstring const getDescription(LyXRCTags);
207 std::string bind_file;
209 std::string def_file;
215 std::string print_command;
217 std::string print_evenpage_flag;
219 std::string print_oddpage_flag;
221 std::string print_pagerange_flag;
223 std::string print_copies_flag;
225 std::string print_collcopies_flag;
227 std::string print_reverse_flag;
229 std::string print_landscape_flag;
231 std::string print_to_printer;
233 bool print_adapt_output;
235 std::string print_to_file;
237 std::string print_file_extension;
239 std::string print_extra_options;
241 std::string print_spool_command;
243 std::string print_spool_printerprefix;
245 std::string print_paper_flag;
247 std::string print_paper_dimension_flag;
248 /// option for telling the dvi viewer about the paper size
249 std::string view_dvi_paper_option;
250 /// default paper size for local xdvi/dvips/ghostview/whatever
251 PAPER_SIZE default_papersize;
252 /// command to run chktex incl. options
253 std::string chktex_command;
254 /// all available commands to run bibtex incl. options
255 std::set<std::string> bibtex_alternatives;
256 /// command to run bibtex incl. options
257 std::string bibtex_command;
258 /// command to run japanese bibtex incl. options
259 std::string jbibtex_command;
260 /// all available index commands incl. options
261 std::set<std::string> index_alternatives;
262 /// command to run makeindex incl. options or other index programs
263 std::string index_command;
264 /// command to run japanese index program incl. options
265 std::string jindex_command;
266 /// command to generate multiple indices
267 std::string splitindex_command;
268 /// command to run makeindex incl. options for nomencl
269 std::string nomencl_command;
271 std::string document_path;
273 std::string example_path;
275 std::string template_path;
277 std::string tempdir_path;
279 std::string thesaurusdir_path;
281 std::string hunspelldir_path;
283 bool auto_region_delete;
284 /// flag telling whether lastfiles should be checked for existance
285 bool auto_reset_options;
287 bool check_lastfiles;
288 /// maximal number of lastfiles
289 unsigned int num_lastfiles;
290 /// whether or not go to saved position when opening a file
291 bool use_lastfilepos;
292 /// load files from last session automatically
294 /// shall a backup file be created
296 /// A directory for storing backup files
297 std::string backupdir_path;
298 /// Whether or not save/restore session information
299 /// like windows position and geometry.
300 bool allow_geometry_session;
301 /// Scrolling speed of the mouse wheel
302 double mouse_wheel_speed;
303 /// Zoom factor for screen fonts
305 /// Screen font sizes in points for each font size
306 std::string font_sizes[10];
307 /// Allow the use of scalable fonts? Default is yes.
308 bool use_scalable_fonts;
314 std::string roman_font_name;
316 std::string sans_font_name;
318 std::string typewriter_font_name;
320 std::string roman_font_foundry;
322 std::string sans_font_foundry;
324 std::string typewriter_font_foundry;
326 unsigned int autosave;
328 unsigned int plaintext_linelen;
329 /// Accept compound words in spellchecker?
330 bool spellchecker_accept_compound;
333 /// Use pixmap cache?
334 bool use_pixmap_cache;
335 /// Spellchecker engine: aspell, hunspell, etc
336 std::string spellchecker;
337 /// Alternate language for spellchecker
338 std::string spellchecker_alt_lang;
339 /// Escape characters
340 std::string spellchecker_esc_chars;
341 /// spellcheck continuously?
342 bool spellcheck_continuously;
346 std::string primary_kbmap;
348 std::string secondary_kbmap;
350 std::string lyxpipes;
352 std::string date_insert_format;
354 std::string language_package;
356 bool language_auto_begin;
358 bool language_auto_end;
360 std::string language_command_begin;
362 std::string language_command_end;
364 std::string language_command_local;
366 bool language_global_options;
368 bool language_use_babel;
371 /// bidi cursor movement: true = visual, false = logical
376 bool mark_foreign_language;
378 std::string default_language;
380 std::string gui_language;
382 std::string default_view_format;
384 bool mac_like_word_movement;
386 bool cursor_follows_scrollbar;
388 bool scroll_below_document;
390 enum MacroEditStyle {
391 MACRO_EDIT_INLINE_BOX = 0,
396 MacroEditStyle macro_edit_style;
398 bool dialogs_iconify_with_main;
400 int label_init_length;
402 bool display_graphics;
412 PreviewStatus preview;
414 bool preview_hashed_labels;
416 std::string preview_scale_factor;
418 std::string user_name;
420 std::string user_email;
421 /// True if the TeX engine cannot handle posix paths
422 bool windows_style_tex_paths;
423 /// True if the TeX engine can handle file names containing spaces
424 bool tex_allows_spaces;
425 /** Prepend paths to the PATH environment variable.
426 * The string is input, stored and output in native format.
428 std::string path_prefix;
429 /// Use the cache for file converters?
430 bool use_converter_cache;
431 /// The maximum age of cache files in seconds
432 unsigned int converter_cache_maxage;
433 /// Sort layouts alphabetically
435 /// Group layout by their category
437 /// Toggle toolbars in fullscreen mode?
438 bool full_screen_toolbars;
439 /// Toggle scrollbar in fullscreen mode?
440 bool full_screen_scrollbar;
441 /// Toggle tabbar in fullscreen mode?
442 bool full_screen_tabbar;
443 /// Toggle menubar in fullscreen mode?
444 bool full_screen_menubar;
445 /// Limit the text width?
446 bool full_screen_limit;
447 /// Width of limited screen (in pixels) in fullscreen mode
448 int full_screen_width;
450 bool completion_cursor_text;
452 double completion_inline_delay;
454 bool completion_inline_math;
456 bool completion_inline_text;
458 int completion_inline_dots;
460 bool autocorrection_math;
462 double completion_popup_delay;
464 bool completion_popup_math;
466 bool completion_popup_text;
468 bool completion_popup_after_complete;
470 bool open_buffers_in_tabs;
474 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
475 * It can be forward-declared and passed as a function argument without
476 * having to expose LyXRC.h.
478 class LyXRC_PreviewStatus {
479 LyXRC::PreviewStatus val_;
481 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
482 operator LyXRC::PreviewStatus() const { return val_; }
489 extern LyXRC system_lyxrc;
491 // used by at least frontends/qt4/GuiPref.cpp
492 const long maxlastfiles = 20;