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.
29 namespace support { class FileName; }
33 /// This contains the runtime configuration of LyX
38 RC_ACCEPT_COMPOUND = 1,
40 RC_PLAINTEXT_ROFF_COMMAND,
52 RC_CONVERTER_CACHE_MAXAGE,
54 RC_CURSOR_FOLLOWS_SCROLLBAR,
55 RC_CUSTOM_EXPORT_COMMAND,
56 RC_CUSTOM_EXPORT_FORMAT,
57 RC_DATE_INSERT_FORMAT,
61 RC_DIALOGS_ICONIFY_WITH_MAIN,
73 RC_LANGUAGE_AUTO_BEGIN,
75 RC_LANGUAGE_COMMAND_BEGIN,
76 RC_LANGUAGE_COMMAND_END,
77 RC_LANGUAGE_COMMAND_LOCAL,
78 RC_LANGUAGE_GLOBAL_OPTIONS,
80 RC_LANGUAGE_USE_BABEL,
84 RC_MARK_FOREIGN_LANGUAGE,
89 RC_PREVIEW_HASHED_LABELS,
90 RC_PREVIEW_SCALE_FACTOR,
91 RC_PRINTCOLLCOPIESFLAG,
95 RC_PRINTEXSTRAOPTIONS,
96 RC_PRINTFILEEXTENSION,
97 RC_PRINTLANDSCAPEFLAG,
99 RC_PRINTPAGERANGEFLAG,
100 RC_PRINTPAPERDIMENSIONFLAG,
103 RC_PRINTSPOOL_COMMAND,
104 RC_PRINTSPOOL_PRINTERPREFIX,
107 RC_PRINT_ADAPTOUTPUT,
111 RC_SCREEN_FONT_ROMAN,
112 RC_SCREEN_FONT_ROMAN_FOUNDRY,
114 RC_SCREEN_FONT_SANS_FOUNDRY,
115 RC_SCREEN_FONT_SCALABLE,
116 RC_SCREEN_FONT_SIZES,
117 RC_SCREEN_FONT_TYPEWRITER,
118 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
119 RC_SCREEN_GEOMETRY_HEIGHT,
120 RC_SCREEN_GEOMETRY_WIDTH,
121 RC_SCREEN_GEOMETRY_XYSAVED,
129 RC_TEX_ALLOWS_SPACES,
130 RC_TEX_EXPECTS_WINDOWS_PATHS,
136 RC_USE_CONVERTER_CACHE,
141 RC_VIEWDVI_PAPEROPTION,
151 int read(support::FileName const & filename);
153 int read(std::istream &);
159 void write(support::FileName const & filename,
160 bool ignore_system_lyxrc) const;
161 /// write rc. If a specific tag is given, only output that one.
162 void write(std::ostream & os,
163 bool ignore_system_lyxrc,
164 std::string const & tag = std::string()) const;
167 // FIXME unused (was used for xforms. Do we still need this?)
168 //static docstring const getDescription(LyXRCTags);
170 std::string bind_file;
172 std::string def_file;
178 std::string print_command;
180 std::string print_evenpage_flag;
182 std::string print_oddpage_flag;
184 std::string print_pagerange_flag;
186 std::string print_copies_flag;
188 std::string print_collcopies_flag;
190 std::string print_reverse_flag;
192 std::string print_landscape_flag;
194 std::string print_to_printer;
196 bool print_adapt_output;
198 std::string print_to_file;
200 std::string print_file_extension;
202 std::string print_extra_options;
204 std::string print_spool_command;
206 std::string print_spool_printerprefix;
208 std::string print_paper_flag;
210 std::string print_paper_dimension_flag;
212 std::string custom_export_command;
214 std::string custom_export_format;
215 /// option for telling the dvi viewer about the paper size
216 std::string view_dvi_paper_option;
217 /// default paper size for local xdvi/dvips/ghostview/whatever
218 PAPER_SIZE default_papersize;
219 /// command to run chktex incl. options
220 std::string chktex_command;
221 /// command to run bibtex incl. options
222 std::string bibtex_command;
223 /// command to run makeindex incl. options or other index programs
224 std::string index_command;
226 std::string document_path;
228 std::string template_path;
230 std::string tempdir_path;
232 bool auto_region_delete;
233 /// flag telling whether lastfiles should be checked for existance
234 bool auto_reset_options;
236 bool check_lastfiles;
237 /// maximal number of lastfiles
238 unsigned int num_lastfiles;
239 /// whether or not go to saved position when opening a file
240 bool use_lastfilepos;
241 /// load files from last session automatically
243 /// shall a backup file be created
245 /// A directory for storing backup files
246 std::string backupdir_path;
247 /// Width of MainWindow. if 0, value from last session will be used
249 /// Height of MainWindow, if 0, value from last session will be used
251 /// Whether or not save/restore windows position as session info
252 bool geometry_xysaved;
253 /// Zoom factor for screen fonts
255 /// Screen font sizes in points for each font size
256 std::string font_sizes[10];
257 /// Allow the use of scalable fonts? Default is yes.
258 bool use_scalable_fonts;
264 std::string roman_font_name;
266 std::string sans_font_name;
268 std::string typewriter_font_name;
270 std::string roman_font_foundry;
272 std::string sans_font_foundry;
274 std::string typewriter_font_foundry;
276 unsigned int autosave;
278 std::string plaintext_roff_command;
280 unsigned int plaintext_linelen;
281 /// use library instead of process
284 std::string isp_command;
285 /// Accept compound words in spellchecker?
286 bool isp_accept_compound;
287 /// Pass input encoding switch to ispell?
288 bool isp_use_input_encoding;
289 /// Use alternate language?
290 bool isp_use_alt_lang;
291 /// Use personal dictionary?
292 bool isp_use_pers_dict;
293 /// Use escape chars?
294 bool isp_use_esc_chars;
295 /// Alternate language for ispell
296 std::string isp_alt_lang;
297 /// Alternate personal dictionary file for ispell
298 std::string isp_pers_dict;
299 /// Escape characters
300 std::string isp_esc_chars;
304 std::string primary_kbmap;
306 std::string secondary_kbmap;
308 std::string lyxpipes;
310 std::string date_insert_format;
312 std::string language_package;
314 bool language_auto_begin;
316 bool language_auto_end;
318 std::string language_command_begin;
320 std::string language_command_end;
322 std::string language_command_local;
324 bool language_global_options;
326 bool language_use_babel;
332 bool mark_foreign_language;
334 std::string default_language;
336 bool cursor_follows_scrollbar;
338 bool dialogs_iconify_with_main;
340 int label_init_length;
342 ///graphics::DisplayType
343 int display_graphics;
353 PreviewStatus preview;
355 bool preview_hashed_labels;
357 std::string preview_scale_factor;
359 std::string user_name;
361 std::string user_email;
362 /// True if the TeX engine cannot handle posix paths
363 bool windows_style_tex_paths;
364 /// True if the TeX engine can handle file names containing spaces
365 bool tex_allows_spaces;
366 /** Prepend paths to the PATH environment variable.
367 * The string is input, stored and output in native format.
369 std::string path_prefix;
370 /// Use the cache for file converters?
371 bool use_converter_cache;
372 /// The maximum age of cache files in seconds
373 unsigned int converter_cache_maxage;
377 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
378 * It can be forward-declared and passed as a function argument without
379 * having to expose LyXRC.h.
381 class LyXRC_PreviewStatus {
382 LyXRC::PreviewStatus val_;
384 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
385 operator LyXRC::PreviewStatus() const { return val_; }
392 extern LyXRC system_lyxrc;