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.
22 #include "graphics/GraphicsTypes.h"
30 namespace support { class FileName; }
34 /// This contains the runtime configuration of LyX
35 class LyXRC //: public noncopyable
36 // after 1.1.6 I will use a LyXRCStruct here and then this can be made
37 // noncopyable again. For now I want to minimise changes. ARRae 20001010
41 RC_ACCEPT_COMPOUND = 1,
43 RC_PLAINTEXT_ROFF_COMMAND,
55 RC_CONVERTER_CACHE_MAXAGE,
57 RC_CURSOR_FOLLOWS_SCROLLBAR,
58 RC_CUSTOM_EXPORT_COMMAND,
59 RC_CUSTOM_EXPORT_FORMAT,
60 RC_DATE_INSERT_FORMAT,
63 RC_DIALOGS_ICONIFY_WITH_MAIN,
75 RC_LANGUAGE_AUTO_BEGIN,
77 RC_LANGUAGE_COMMAND_BEGIN,
78 RC_LANGUAGE_COMMAND_END,
79 RC_LANGUAGE_COMMAND_LOCAL,
80 RC_LANGUAGE_GLOBAL_OPTIONS,
82 RC_LANGUAGE_USE_BABEL,
86 RC_MARK_FOREIGN_LANGUAGE,
91 RC_PREVIEW_HASHED_LABELS,
92 RC_PREVIEW_SCALE_FACTOR,
93 RC_PRINTCOLLCOPIESFLAG,
97 RC_PRINTEXSTRAOPTIONS,
98 RC_PRINTFILEEXTENSION,
99 RC_PRINTLANDSCAPEFLAG,
101 RC_PRINTPAGERANGEFLAG,
102 RC_PRINTPAPERDIMENSIONFLAG,
105 RC_PRINTSPOOL_COMMAND,
106 RC_PRINTSPOOL_PRINTERPREFIX,
109 RC_PRINT_ADAPTOUTPUT,
113 RC_SCREEN_FONT_ROMAN,
114 RC_SCREEN_FONT_ROMAN_FOUNDRY,
116 RC_SCREEN_FONT_SANS_FOUNDRY,
117 RC_SCREEN_FONT_SCALABLE,
118 RC_SCREEN_FONT_SIZES,
119 RC_SCREEN_FONT_TYPEWRITER,
120 RC_SCREEN_FONT_TYPEWRITER_FOUNDRY,
121 RC_SCREEN_GEOMETRY_HEIGHT,
122 RC_SCREEN_GEOMETRY_WIDTH,
123 RC_SCREEN_GEOMETRY_XYSAVED,
131 RC_TEX_ALLOWS_SPACES,
132 RC_TEX_EXPECTS_WINDOWS_PATHS,
138 RC_USE_CONVERTER_CACHE,
143 RC_VIEWDVI_PAPEROPTION,
153 int read(support::FileName const & filename);
155 int read(std::istream &);
161 void write(support::FileName const & filename,
162 bool ignore_system_lyxrc) const;
164 void write(std::ostream & os,
165 bool ignore_system_lyxrc) const;
168 // FIXME unused (was used for xforms. Do we still need this?)
169 //static docstring const getDescription(LyXRCTags);
171 std::string bind_file;
177 std::string print_command;
179 std::string print_evenpage_flag;
181 std::string print_oddpage_flag;
183 std::string print_pagerange_flag;
185 std::string print_copies_flag;
187 std::string print_collcopies_flag;
189 std::string print_reverse_flag;
191 std::string print_landscape_flag;
193 std::string print_to_printer;
195 bool print_adapt_output;
197 std::string print_to_file;
199 std::string print_file_extension;
201 std::string print_extra_options;
203 std::string print_spool_command;
205 std::string print_spool_printerprefix;
207 std::string print_paper_flag;
209 std::string print_paper_dimension_flag;
211 std::string custom_export_command;
213 std::string custom_export_format;
214 /// option for telling the dvi viewer about the paper size
215 std::string view_dvi_paper_option;
216 /// default paper size for local xdvi/dvips/ghostview/whatever
217 PAPER_SIZE default_papersize;
218 /// command to run chktex incl. options
219 std::string chktex_command;
220 /// command to run bibtex incl. options
221 std::string bibtex_command;
222 /// command to run makeindex incl. options or other index programs
223 std::string index_command;
225 std::string document_path;
227 std::string template_path;
229 std::string tempdir_path;
231 bool auto_region_delete;
232 /// flag telling whether lastfiles should be checked for existance
233 bool auto_reset_options;
235 bool check_lastfiles;
236 /// maximal number of lastfiles
237 unsigned int num_lastfiles;
238 /// whether or not go to saved position when opening a file
239 bool use_lastfilepos;
240 /// load files from last session automatically
242 /// shall a backup file be created
244 /// A directory for storing backup files
245 std::string backupdir_path;
246 /// Width of MainWindow. if 0, value from last session will be used
248 /// Height of MainWindow, if 0, value from last session will be used
250 /// Whether or not save/restore windows position as session info
251 bool geometry_xysaved;
252 /// Zoom factor for screen fonts
254 /// Screen font sizes in points for each font size
255 std::string font_sizes[10];
256 /// Allow the use of scalable fonts? Default is yes.
257 bool use_scalable_fonts;
263 std::string roman_font_name;
265 std::string sans_font_name;
267 std::string typewriter_font_name;
269 std::string roman_font_foundry;
271 std::string sans_font_foundry;
273 std::string typewriter_font_foundry;
275 unsigned int autosave;
277 std::string plaintext_roff_command;
279 unsigned int plaintext_linelen;
280 /// use library instead of process
283 std::string isp_command;
284 /// Accept compound words in spellchecker?
285 bool isp_accept_compound;
286 /// Pass input encoding switch to ispell?
287 bool isp_use_input_encoding;
288 /// Use alternate language?
289 bool isp_use_alt_lang;
290 /// Use personal dictionary?
291 bool isp_use_pers_dict;
292 /// Use escape chars?
293 bool isp_use_esc_chars;
294 /// Alternate language for ispell
295 std::string isp_alt_lang;
296 /// Alternate personal dictionary file for ispell
297 std::string isp_pers_dict;
298 /// Escape characters
299 std::string isp_esc_chars;
303 std::string primary_kbmap;
305 std::string secondary_kbmap;
307 std::string lyxpipes;
309 std::string date_insert_format;
311 std::string language_package;
313 bool language_auto_begin;
315 bool language_auto_end;
317 std::string language_command_begin;
319 std::string language_command_end;
321 std::string language_command_local;
323 bool language_global_options;
325 bool language_use_babel;
331 bool mark_foreign_language;
333 std::string default_language;
335 bool cursor_follows_scrollbar;
337 bool dialogs_iconify_with_main;
339 int label_init_length;
341 graphics::DisplayType display_graphics;
351 PreviewStatus preview;
353 bool preview_hashed_labels;
355 std::string preview_scale_factor;
357 std::string user_name;
359 std::string user_email;
360 /// True if the TeX engine cannot handle posix paths
361 bool windows_style_tex_paths;
362 /// True if the TeX engine can handle file names containing spaces
363 bool tex_allows_spaces;
364 /** Prepend paths to the PATH environment variable.
365 * The string is input, stored and output in native format.
367 std::string path_prefix;
368 /// Use the cache for file converters?
369 bool use_converter_cache;
370 /// The maximum age of cache files in seconds
371 unsigned int converter_cache_maxage;
375 /** \c LyXRC_PreviewStatus is a wrapper for LyXRC::PreviewStatus.
376 * It can be forward-declared and passed as a function argument without
377 * having to expose LyXRC.h.
379 class LyXRC_PreviewStatus {
380 LyXRC::PreviewStatus val_;
382 LyXRC_PreviewStatus(LyXRC::PreviewStatus val) : val_(val) {}
383 operator LyXRC::PreviewStatus() const{ return val_; }
390 extern LyXRC system_lyxrc;