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_MINLENGTH,
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,
69 RC_DATE_INSERT_FORMAT,
70 RC_DEFAULT_DECIMAL_POINT,
71 RC_DEFAULT_LENGTH_UNIT,
72 RC_DEFAULT_OTF_VIEW_FORMAT,
73 RC_DEFAULT_VIEW_FORMAT,
75 RC_DIALOGS_ICONIFY_WITH_MAIN,
78 RC_EDITOR_ALTERNATIVES,
84 RC_FORWARD_SEARCH_DVI,
85 RC_FORWARD_SEARCH_PDF,
87 RC_FULL_SCREEN_SCROLLBAR,
88 RC_FULL_SCREEN_STATUSBAR,
89 RC_FULL_SCREEN_TABBAR,
90 RC_FULL_SCREEN_MENUBAR,
91 RC_FULL_SCREEN_TOOLBARS,
98 RC_INDEX_ALTERNATIVES,
101 RC_JBIBTEX_ALTERNATIVES,
107 RC_LANGUAGE_AUTO_BEGIN,
108 RC_LANGUAGE_AUTO_END,
109 RC_LANGUAGE_COMMAND_BEGIN,
110 RC_LANGUAGE_COMMAND_END,
111 RC_LANGUAGE_COMMAND_LOCAL,
112 RC_LANGUAGE_GLOBAL_OPTIONS,
113 RC_LANGUAGE_CUSTOM_PACKAGE,
114 RC_LANGUAGE_PACKAGE_SELECTION,
118 RC_MAC_DONTSWAP_CTRL_META,
119 RC_MAC_LIKE_CURSOR_MOVEMENT,
121 RC_MARK_FOREIGN_LANGUAGE,
122 RC_MOUSE_WHEEL_SPEED,
123 RC_MOUSE_MIDDLEBUTTON_PASTE,
126 RC_OPEN_BUFFERS_IN_TABS,
127 RC_PARAGRAPH_MARKERS,
129 RC_PLAINTEXT_LINELEN,
131 RC_PREVIEW_HASHED_LABELS,
132 RC_PREVIEW_SCALE_FACTOR,
133 RC_PRINTLANDSCAPEFLAG,
134 RC_PRINTPAPERDIMENSIONFLAG,
139 RC_SCREEN_FONT_ROMAN,
140 RC_SCREEN_FONT_ROMAN_FOUNDRY,
142 RC_SCREEN_FONT_SANS_FOUNDRY,
143 RC_SCREEN_FONT_SCALABLE,
144 RC_SCREEN_FONT_SIZES,
145 RC_SCREEN_FONT_TYPEWRITER,
146 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
148 RC_SCROLL_BELOW_DOCUMENT,
149 RC_SCROLL_WHEEL_ZOOM,
153 RC_SINGLE_CLOSE_TAB_BUTTON,
156 RC_SPELLCHECK_CONTINUOUSLY,
159 RC_SPLITINDEX_COMMAND,
162 RC_TEX_ALLOWS_SPACES,
163 RC_TEX_EXPECTS_WINDOWS_PATHS,
170 RC_USE_CONVERTER_CACHE,
171 RC_USE_CONVERTER_NEEDAUTH_FORBIDDEN,
172 RC_USE_CONVERTER_NEEDAUTH,
173 RC_USE_SYSTEM_COLORS,
177 RC_USE_SYSTEM_THEME_ICONS,
178 RC_VIEWDVI_PAPEROPTION,
180 RC_VIEWER_ALTERNATIVES,
182 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
190 /// \param check_format: whether to try to convert the file format,
191 /// if it is not current. this should only be true, really, for the
192 /// user's own preferences file.
193 bool read(support::FileName const & filename, bool check_format);
195 bool read(std::istream &);
203 ReturnValues read(Lexer &, bool check_format);
206 typedef std::set<std::string> CommandSet;
207 /// maps a format to a set of commands that can be used to
209 typedef std::map<std::string, CommandSet> Alternatives;
211 void write(support::FileName const & filename,
212 bool ignore_system_lyxrc) const;
213 /// write rc. If a specific tag is given, only output that one.
214 void write(std::ostream & os,
215 bool ignore_system_lyxrc,
216 std::string const & tag = std::string()) const;
219 // FIXME unused (was used for xforms. Do we still need this?)
220 //static docstring const getDescription(LyXRCTags);
222 std::string bind_file;
224 std::string def_file;
228 std::string print_landscape_flag;
230 std::string print_paper_flag;
232 std::string print_paper_dimension_flag;
233 /// option for telling the dvi viewer about the paper size
234 std::string view_dvi_paper_option;
235 /// default paper size for local xdvi/dvips/ghostview/whatever
236 /// command to run chktex incl. options
237 std::string chktex_command;
238 /// all available commands to run bibtex incl. options
239 CommandSet bibtex_alternatives;
240 /// command to run bibtex incl. options
241 std::string bibtex_command;
242 /// command to run japanese bibtex incl. options
243 std::string jbibtex_command;
244 /// all available commands to run japanese bibtex incl. options
245 CommandSet jbibtex_alternatives;
246 /// all available index commands incl. options
247 CommandSet index_alternatives;
248 /// command to run makeindex incl. options or other index programs
249 std::string index_command;
250 /// command to run japanese index program incl. options
251 std::string jindex_command;
252 /// command to generate multiple indices
253 std::string splitindex_command;
254 /// command to run makeindex incl. options for nomencl
255 std::string nomencl_command;
257 std::string document_path;
259 std::string example_path;
261 std::string template_path;
263 std::string tempdir_path;
265 std::string thesaurusdir_path;
267 std::string hunspelldir_path;
269 bool auto_region_delete;
270 /// enable middle-mouse-button paste
271 bool mouse_middlebutton_paste;
272 /// flag telling whether lastfiles should be checked for existance
273 bool auto_reset_options;
275 bool check_lastfiles;
276 /// maximal number of lastfiles
277 unsigned int num_lastfiles;
278 /// whether or not go to saved position when opening a file
279 bool use_lastfilepos;
280 /// load files from last session automatically
282 /// do we save new documents as compressed by default
283 bool save_compressed;
284 /// whether or not to save the document dir in the file
286 /// shall a backup file be created
288 /// A directory for storing backup files
289 std::string backupdir_path;
290 /// Whether or not save/restore session information
291 /// like windows position and geometry.
292 bool allow_geometry_session;
293 /// Scrolling speed of the mouse wheel
294 double mouse_wheel_speed;
295 /// Zoom factor for screen fonts
297 /// Screen font sizes in points for each font size
298 std::string font_sizes[10];
299 /// Allow the use of scalable fonts? Default is yes.
300 bool use_scalable_fonts;
306 std::string roman_font_name;
308 std::string sans_font_name;
310 std::string typewriter_font_name;
312 std::string roman_font_foundry;
314 std::string sans_font_foundry;
316 std::string typewriter_font_foundry;
318 unsigned int autosave;
320 unsigned int plaintext_linelen;
321 /// Accept compound words in spellchecker?
322 bool spellchecker_accept_compound;
323 /// End of paragraph markers?
324 bool paragraph_markers;
327 /// Use the colors from current system theme?
328 bool use_system_colors;
329 /// Use pixmap cache?
330 bool use_pixmap_cache;
331 /// Use QImage backend?
333 /// Spellchecker engine: aspell, hunspell, etc
334 std::string spellchecker;
335 /// Alternate language for spellchecker
336 std::string spellchecker_alt_lang;
337 /// Escape characters
338 std::string spellchecker_esc_chars;
339 /// spellcheck continuously?
340 bool spellcheck_continuously;
341 /// spellcheck notes and comments?
342 bool spellcheck_notes;
343 /// minimum length of words to complete
344 unsigned int completion_minlength;
348 std::string primary_kbmap;
350 std::string secondary_kbmap;
352 std::string lyxpipes;
354 std::string date_insert_format;
356 std::string language_custom_package;
358 bool language_auto_begin;
360 bool language_auto_end;
362 std::string language_command_begin;
364 std::string language_command_end;
366 std::string language_command_local;
368 bool language_global_options;
370 enum LangPackageSelection {
377 LangPackageSelection language_package_selection;
378 /// bidi cursor movement: true = visual, false = logical
383 bool mark_foreign_language;
385 std::string gui_language;
387 std::string default_otf_view_format;
389 std::string default_view_format;
390 /// all available viewers
391 Alternatives viewer_alternatives;
392 /// all available editors
393 Alternatives editor_alternatives;
395 bool mac_dontswap_ctrl_meta;
397 bool mac_like_cursor_movement;
399 bool cursor_follows_scrollbar;
401 bool scroll_below_document;
403 enum MacroEditStyle {
404 MACRO_EDIT_INLINE_BOX = 0,
409 MacroEditStyle macro_edit_style;
411 bool dialogs_iconify_with_main;
413 bool display_graphics;
423 PreviewStatus preview;
425 bool preview_hashed_labels;
427 double preview_scale_factor;
429 std::string user_name;
431 std::string user_email;
433 std::string icon_set;
434 /// whether to use the icons from the theme
435 bool use_system_theme_icons;
436 /// True if the TeX engine cannot handle posix paths
437 bool windows_style_tex_paths;
438 /// True if the TeX engine can handle file names containing spaces
439 bool tex_allows_spaces;
440 /** Prepend paths to the PATH environment variable.
441 * The string is input, stored and output in native format.
443 std::string path_prefix;
444 /** Prepend paths to the TEXINPUTS environment variable.
445 * The string is input, stored and output in native format.
446 * A '.' here stands for the current document directory.
448 std::string texinputs_prefix;
449 /// Use the cache for file converters?
450 bool use_converter_cache;
451 /// Forbid use of external converters with 'needauth' option
452 bool use_converter_needauth_forbidden;
453 /// Ask user before calling external converters with 'needauth' option
454 bool use_converter_needauth;
455 /// The maximum age of cache files in seconds
456 unsigned int converter_cache_maxage;
457 /// Sort layouts alphabetically
459 /// Group layout by their category
461 /// Toggle toolbars in fullscreen mode?
462 bool full_screen_toolbars;
463 /// Toggle scrollbar in fullscreen mode?
464 bool full_screen_scrollbar;
465 /// Toggle tabbar in fullscreen mode?
466 bool full_screen_tabbar;
467 /// Toggle menubar in fullscreen mode?
468 bool full_screen_menubar;
469 /// Toggle statusbar in fullscreen mode?
470 bool full_screen_statusbar;
471 /// Limit the text width?
472 bool full_screen_limit;
473 /// Width of limited screen (in pixels) in fullscreen mode
474 int full_screen_width;
476 bool completion_cursor_text;
478 double completion_inline_delay;
480 bool completion_inline_math;
482 bool completion_inline_text;
484 int completion_inline_dots;
486 bool autocorrection_math;
488 double completion_popup_delay;
490 bool completion_popup_math;
492 bool completion_popup_text;
494 bool completion_popup_after_complete;
496 bool open_buffers_in_tabs;
498 bool single_close_tab_button;
500 bool single_instance;
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 Length::UNIT default_length_unit;
512 enum ScrollWheelZoom {
513 SCROLL_WHEEL_ZOOM_OFF,
514 SCROLL_WHEEL_ZOOM_CTRL,
515 SCROLL_WHEEL_ZOOM_SHIFT,
516 SCROLL_WHEEL_ZOOM_ALT
519 ScrollWheelZoom scroll_wheel_zoom;
522 /// One of: yes, no, ask
523 std::string close_buffer_with_last_view;
527 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
532 extern LyXRC system_lyxrc;
534 // used by at least frontends/qt4/GuiPref.cpp
535 const long maxlastfiles = 50;