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,
106 RC_LANGUAGE_AUTO_BEGIN,
107 RC_LANGUAGE_AUTO_END,
108 RC_LANGUAGE_COMMAND_BEGIN,
109 RC_LANGUAGE_COMMAND_END,
110 RC_LANGUAGE_COMMAND_LOCAL,
111 RC_LANGUAGE_GLOBAL_OPTIONS,
112 RC_LANGUAGE_CUSTOM_PACKAGE,
113 RC_LANGUAGE_PACKAGE_SELECTION,
117 RC_MAC_DONTSWAP_CTRL_META,
118 RC_MAC_LIKE_CURSOR_MOVEMENT,
120 RC_MARK_FOREIGN_LANGUAGE,
121 RC_MOUSE_WHEEL_SPEED,
122 RC_MOUSE_MIDDLEBUTTON_PASTE,
125 RC_OPEN_BUFFERS_IN_TABS,
126 RC_PARAGRAPH_MARKERS,
128 RC_PLAINTEXT_LINELEN,
130 RC_PREVIEW_HASHED_LABELS,
131 RC_PREVIEW_SCALE_FACTOR,
132 RC_PRINTLANDSCAPEFLAG,
133 RC_PRINTPAPERDIMENSIONFLAG,
138 RC_SCREEN_FONT_ROMAN,
139 RC_SCREEN_FONT_ROMAN_FOUNDRY,
141 RC_SCREEN_FONT_SANS_FOUNDRY,
142 RC_SCREEN_FONT_SCALABLE,
143 RC_SCREEN_FONT_SIZES,
144 RC_SCREEN_FONT_TYPEWRITER,
145 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
147 RC_SCROLL_BELOW_DOCUMENT,
148 RC_SCROLL_WHEEL_ZOOM,
152 RC_SINGLE_CLOSE_TAB_BUTTON,
155 RC_SPELLCHECK_CONTINUOUSLY,
158 RC_SPLITINDEX_COMMAND,
161 RC_TEX_ALLOWS_SPACES,
162 RC_TEX_EXPECTS_WINDOWS_PATHS,
169 RC_USE_CONVERTER_CACHE,
170 RC_USE_SYSTEM_COLORS,
174 RC_USE_SYSTEM_THEME_ICONS,
175 RC_VIEWDVI_PAPEROPTION,
177 RC_VIEWER_ALTERNATIVES,
179 RC_CLOSE_BUFFER_WITH_LAST_VIEW,
187 /// \param check_format: whether to try to convert the file format,
188 /// if it is not current. this should only be true, really, for the
189 /// user's own preferences file.
190 bool read(support::FileName const & filename, bool check_format);
192 bool read(std::istream &);
200 ReturnValues read(Lexer &, bool check_format);
203 typedef std::set<std::string> CommandSet;
204 /// maps a format to a set of commands that can be used to
206 typedef std::map<std::string, CommandSet> Alternatives;
208 void write(support::FileName const & filename,
209 bool ignore_system_lyxrc) const;
210 /// write rc. If a specific tag is given, only output that one.
211 void write(std::ostream & os,
212 bool ignore_system_lyxrc,
213 std::string const & tag = std::string()) const;
216 // FIXME unused (was used for xforms. Do we still need this?)
217 //static docstring const getDescription(LyXRCTags);
219 std::string bind_file;
221 std::string def_file;
225 std::string print_landscape_flag;
227 std::string print_paper_flag;
229 std::string print_paper_dimension_flag;
230 /// option for telling the dvi viewer about the paper size
231 std::string view_dvi_paper_option;
232 /// default paper size for local xdvi/dvips/ghostview/whatever
233 /// command to run chktex incl. options
234 std::string chktex_command;
235 /// all available commands to run bibtex incl. options
236 CommandSet bibtex_alternatives;
237 /// command to run bibtex incl. options
238 std::string bibtex_command;
239 /// command to run japanese bibtex incl. options
240 std::string jbibtex_command;
241 /// all available index commands incl. options
242 CommandSet index_alternatives;
243 /// command to run makeindex incl. options or other index programs
244 std::string index_command;
245 /// command to run japanese index program incl. options
246 std::string jindex_command;
247 /// command to generate multiple indices
248 std::string splitindex_command;
249 /// command to run makeindex incl. options for nomencl
250 std::string nomencl_command;
252 std::string document_path;
254 std::string example_path;
256 std::string template_path;
258 std::string tempdir_path;
260 std::string thesaurusdir_path;
262 std::string hunspelldir_path;
264 bool auto_region_delete;
265 /// enable middle-mouse-button paste
266 bool mouse_middlebutton_paste;
267 /// flag telling whether lastfiles should be checked for existance
268 bool auto_reset_options;
270 bool check_lastfiles;
271 /// maximal number of lastfiles
272 unsigned int num_lastfiles;
273 /// whether or not go to saved position when opening a file
274 bool use_lastfilepos;
275 /// load files from last session automatically
277 /// do we save new documents as compressed by default
278 bool save_compressed;
279 /// whether or not to save the document dir in the file
281 /// shall a backup file be created
283 /// A directory for storing backup files
284 std::string backupdir_path;
285 /// Whether or not save/restore session information
286 /// like windows position and geometry.
287 bool allow_geometry_session;
288 /// Scrolling speed of the mouse wheel
289 double mouse_wheel_speed;
290 /// Zoom factor for screen fonts
292 /// Screen font sizes in points for each font size
293 std::string font_sizes[10];
294 /// Allow the use of scalable fonts? Default is yes.
295 bool use_scalable_fonts;
301 std::string roman_font_name;
303 std::string sans_font_name;
305 std::string typewriter_font_name;
307 std::string roman_font_foundry;
309 std::string sans_font_foundry;
311 std::string typewriter_font_foundry;
313 unsigned int autosave;
315 unsigned int plaintext_linelen;
316 /// Accept compound words in spellchecker?
317 bool spellchecker_accept_compound;
318 /// End of paragraph markers?
319 bool paragraph_markers;
322 /// Use the colors from current system theme?
323 bool use_system_colors;
324 /// Use pixmap cache?
325 bool use_pixmap_cache;
326 /// Use QImage backend?
328 /// Spellchecker engine: aspell, hunspell, etc
329 std::string spellchecker;
330 /// Alternate language for spellchecker
331 std::string spellchecker_alt_lang;
332 /// Escape characters
333 std::string spellchecker_esc_chars;
334 /// spellcheck continuously?
335 bool spellcheck_continuously;
336 /// spellcheck notes and comments?
337 bool spellcheck_notes;
338 /// minimum length of words to complete
339 unsigned int completion_minlength;
343 std::string primary_kbmap;
345 std::string secondary_kbmap;
347 std::string lyxpipes;
349 std::string date_insert_format;
351 std::string language_custom_package;
353 bool language_auto_begin;
355 bool language_auto_end;
357 std::string language_command_begin;
359 std::string language_command_end;
361 std::string language_command_local;
363 bool language_global_options;
365 enum LangPackageSelection {
372 LangPackageSelection language_package_selection;
373 /// bidi cursor movement: true = visual, false = logical
378 bool mark_foreign_language;
380 std::string gui_language;
382 std::string default_otf_view_format;
384 std::string default_view_format;
385 /// all available viewers
386 Alternatives viewer_alternatives;
387 /// all available editors
388 Alternatives editor_alternatives;
390 bool mac_dontswap_ctrl_meta;
392 bool mac_like_cursor_movement;
394 bool cursor_follows_scrollbar;
396 bool scroll_below_document;
398 enum MacroEditStyle {
399 MACRO_EDIT_INLINE_BOX = 0,
404 MacroEditStyle macro_edit_style;
406 bool dialogs_iconify_with_main;
408 bool display_graphics;
418 PreviewStatus preview;
420 bool preview_hashed_labels;
422 double preview_scale_factor;
424 std::string user_name;
426 std::string user_email;
428 std::string icon_set;
429 /// whether to use the icons from the theme
430 bool use_system_theme_icons;
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 /** Prepend paths to the TEXINPUTS environment variable.
440 * The string is input, stored and output in native format.
441 * A '.' here stands for the current document directory.
443 std::string texinputs_prefix;
444 /// Use the cache for file converters?
445 bool use_converter_cache;
446 /// The maximum age of cache files in seconds
447 unsigned int converter_cache_maxage;
448 /// Sort layouts alphabetically
450 /// Group layout by their category
452 /// Toggle toolbars in fullscreen mode?
453 bool full_screen_toolbars;
454 /// Toggle scrollbar in fullscreen mode?
455 bool full_screen_scrollbar;
456 /// Toggle tabbar in fullscreen mode?
457 bool full_screen_tabbar;
458 /// Toggle menubar in fullscreen mode?
459 bool full_screen_menubar;
460 /// Toggle statusbar in fullscreen mode?
461 bool full_screen_statusbar;
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;
491 bool single_instance;
493 std::string forward_search_dvi;
495 std::string forward_search_pdf;
497 int export_overwrite;
498 /// Default decimal point when aligning table columns on decimal
499 std::string default_decimal_point;
501 Length::UNIT default_length_unit;
503 enum ScrollWheelZoom {
504 SCROLL_WHEEL_ZOOM_OFF,
505 SCROLL_WHEEL_ZOOM_CTRL,
506 SCROLL_WHEEL_ZOOM_SHIFT,
507 SCROLL_WHEEL_ZOOM_ALT
510 ScrollWheelZoom scroll_wheel_zoom;
513 /// One of: yes, no, ask
514 std::string close_buffer_with_last_view;
518 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
523 extern LyXRC system_lyxrc;
525 // used by at least frontends/qt4/GuiPref.cpp
526 const long maxlastfiles = 50;