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"
32 namespace support { class FileName; }
36 /// This contains the runtime configuration of LyX
41 RC_ACCEPT_COMPOUND = 1,
43 RC_AUTOCORRECTION_MATH,
49 RC_BIBTEX_ALTERNATIVES,
54 RC_COMPLETION_CURSOR_TEXT,
55 RC_COMPLETION_INLINE_DELAY,
56 RC_COMPLETION_INLINE_MATH,
57 RC_COMPLETION_INLINE_TEXT,
58 RC_COMPLETION_INLINE_DOTS,
59 RC_COMPLETION_POPUP_DELAY,
60 RC_COMPLETION_POPUP_MATH,
61 RC_COMPLETION_POPUP_TEXT,
62 RC_COMPLETION_POPUP_AFTER_COMPLETE,
64 RC_CONVERTER_CACHE_MAXAGE,
66 RC_CURSOR_FOLLOWS_SCROLLBAR,
67 RC_DATE_INSERT_FORMAT,
69 RC_DEFAULT_VIEW_FORMAT,
72 RC_DIALOGS_ICONIFY_WITH_MAIN,
75 RC_EDITOR_ALTERNATIVES,
81 RC_FULL_SCREEN_SCROLLBAR,
82 RC_FULL_SCREEN_TABBAR,
83 RC_FULL_SCREEN_MENUBAR,
84 RC_FULL_SCREEN_TOOLBARS,
90 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,
159 RC_SPELLCHECK_CONTINUOUSLY,
161 RC_SPLITINDEX_COMMAND,
164 RC_TEX_ALLOWS_SPACES,
165 RC_TEX_EXPECTS_WINDOWS_PATHS,
173 RC_USE_CONVERTER_CACHE,
180 RC_VIEWDVI_PAPEROPTION,
182 RC_VIEWER_ALTERNATIVES,
192 int read(support::FileName const & filename);
194 int read(std::istream &);
200 void write(support::FileName const & filename,
201 bool ignore_system_lyxrc) const;
202 /// write rc. If a specific tag is given, only output that one.
203 void write(std::ostream & os,
204 bool ignore_system_lyxrc,
205 std::string const & tag = std::string()) const;
208 // FIXME unused (was used for xforms. Do we still need this?)
209 //static docstring const getDescription(LyXRCTags);
211 std::string bind_file;
213 std::string def_file;
219 std::string print_command;
221 std::string print_evenpage_flag;
223 std::string print_oddpage_flag;
225 std::string print_pagerange_flag;
227 std::string print_copies_flag;
229 std::string print_collcopies_flag;
231 std::string print_reverse_flag;
233 std::string print_landscape_flag;
235 std::string print_to_printer;
237 bool print_adapt_output;
239 std::string print_to_file;
241 std::string print_file_extension;
243 std::string print_extra_options;
245 std::string print_spool_command;
247 std::string print_spool_printerprefix;
249 std::string print_paper_flag;
251 std::string print_paper_dimension_flag;
252 /// option for telling the dvi viewer about the paper size
253 std::string view_dvi_paper_option;
254 /// default paper size for local xdvi/dvips/ghostview/whatever
255 PAPER_SIZE default_papersize;
256 /// command to run chktex incl. options
257 std::string chktex_command;
258 /// all available commands to run bibtex incl. options
259 std::set<std::string> bibtex_alternatives;
260 /// command to run bibtex incl. options
261 std::string bibtex_command;
262 /// command to run japanese bibtex incl. options
263 std::string jbibtex_command;
264 /// all available index commands incl. options
265 std::set<std::string> index_alternatives;
266 /// command to run makeindex incl. options or other index programs
267 std::string index_command;
268 /// command to run japanese index program incl. options
269 std::string jindex_command;
270 /// command to generate multiple indices
271 std::string splitindex_command;
272 /// command to run makeindex incl. options for nomencl
273 std::string nomencl_command;
275 std::string document_path;
277 std::string example_path;
279 std::string template_path;
281 std::string tempdir_path;
283 std::string thesaurusdir_path;
285 std::string hunspelldir_path;
287 bool auto_region_delete;
288 /// flag telling whether lastfiles should be checked for existance
289 bool auto_reset_options;
291 bool check_lastfiles;
292 /// maximal number of lastfiles
293 unsigned int num_lastfiles;
294 /// whether or not go to saved position when opening a file
295 bool use_lastfilepos;
296 /// load files from last session automatically
298 /// shall a backup file be created
300 /// A directory for storing backup files
301 std::string backupdir_path;
302 /// Whether or not save/restore session information
303 /// like windows position and geometry.
304 bool allow_geometry_session;
305 /// Scrolling speed of the mouse wheel
306 double mouse_wheel_speed;
307 /// Zoom factor for screen fonts
309 /// Screen font sizes in points for each font size
310 std::string font_sizes[10];
311 /// Allow the use of scalable fonts? Default is yes.
312 bool use_scalable_fonts;
318 std::string roman_font_name;
320 std::string sans_font_name;
322 std::string typewriter_font_name;
324 std::string roman_font_foundry;
326 std::string sans_font_foundry;
328 std::string typewriter_font_foundry;
330 unsigned int autosave;
332 unsigned int plaintext_linelen;
333 /// Accept compound words in spellchecker?
334 bool spellchecker_accept_compound;
335 /// End of paragraph markers?
336 bool paragraph_markers;
339 /// Use pixmap cache?
340 bool use_pixmap_cache;
341 /// Spellchecker engine: aspell, hunspell, etc
342 std::string spellchecker;
343 /// Alternate language for spellchecker
344 std::string spellchecker_alt_lang;
345 /// Escape characters
346 std::string spellchecker_esc_chars;
347 /// spellcheck continuously?
348 bool spellcheck_continuously;
352 std::string primary_kbmap;
354 std::string secondary_kbmap;
356 std::string lyxpipes;
358 std::string date_insert_format;
360 std::string language_package;
362 bool language_auto_begin;
364 bool language_auto_end;
366 std::string language_command_begin;
368 std::string language_command_end;
370 std::string language_command_local;
372 bool language_global_options;
374 bool language_use_babel;
377 /// bidi cursor movement: true = visual, false = logical
382 bool mark_foreign_language;
384 std::string default_language;
386 std::string gui_language;
388 std::string default_view_format;
389 /// all available viewers
390 std::vector<std::pair<std::string, std::string> > viewer_alternatives;
391 /// all available editors
392 std::vector<std::pair<std::string, std::string> > editor_alternatives;
394 bool mac_like_word_movement;
396 bool cursor_follows_scrollbar;
398 bool scroll_below_document;
400 enum MacroEditStyle {
401 MACRO_EDIT_INLINE_BOX = 0,
406 MacroEditStyle macro_edit_style;
408 bool dialogs_iconify_with_main;
410 int label_init_length;
412 bool display_graphics;
422 PreviewStatus preview;
424 bool preview_hashed_labels;
426 std::string preview_scale_factor;
428 std::string user_name;
430 std::string user_email;
431 /// True if the TeX engine cannot handle posix paths
432 bool windows_style_tex_paths;
433 /// True if the TeX engine can handle file names containing spaces
434 bool tex_allows_spaces;
435 /** Prepend paths to the PATH environment variable.
436 * The string is input, stored and output in native format.
438 std::string path_prefix;
439 /// Use the cache for file converters?
440 bool use_converter_cache;
441 /// The maximum age of cache files in seconds
442 unsigned int converter_cache_maxage;
443 /// Sort layouts alphabetically
445 /// Group layout by their category
447 /// Toggle toolbars in fullscreen mode?
448 bool full_screen_toolbars;
449 /// Toggle scrollbar in fullscreen mode?
450 bool full_screen_scrollbar;
451 /// Toggle tabbar in fullscreen mode?
452 bool full_screen_tabbar;
453 /// Toggle menubar in fullscreen mode?
454 bool full_screen_menubar;
455 /// Limit the text width?
456 bool full_screen_limit;
457 /// Width of limited screen (in pixels) in fullscreen mode
458 int full_screen_width;
460 bool completion_cursor_text;
462 double completion_inline_delay;
464 bool completion_inline_math;
466 bool completion_inline_text;
468 int completion_inline_dots;
470 bool autocorrection_math;
472 double completion_popup_delay;
474 bool completion_popup_math;
476 bool completion_popup_text;
478 bool completion_popup_after_complete;
480 bool open_buffers_in_tabs;
484 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
485 * It can be forward-declared and passed as a function argument without
486 * having to expose LyXRC.h.
488 class LyXRC_PreviewStatus {
489 LyXRC::PreviewStatus val_;
491 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
492 operator LyXRC::PreviewStatus() const { return val_; }
499 extern LyXRC system_lyxrc;
501 // used by at least frontends/qt4/GuiPref.cpp
502 const long maxlastfiles = 20;