3 * \file src/PDFOptions.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "support/strfwd.h"
23 /// Options for PDF generation
27 PDFOptions() { clear(); }
28 /// check whether user added any settings for hyperref
30 /// output to lyx header
31 void writeFile(std::ostream &) const;
32 /// output to tex header
33 void writeLaTeX(odocstream &, bool hyperref_already_provided) const;
34 /// read tokens from lyx header
35 std::string readToken(Lexer &lex, std::string const & token);
36 /// set implicit settings for hyperref
50 * A set of Acrobat bookmarks are written, in a manner similar to the
52 * bookmarks boolean true
56 * If Acrobat bookmarks are requested, include section numbers.
57 * bookmarksnumbered boolean false
59 bool bookmarksnumbered;
61 * If Acrobat bookmarks are requested, show them with all the subtrees
63 * bookmarksopen boolean false
67 * Level (\maxdimen) to which bookmarks are open
68 * bookmarksopenlevel parameter
70 int bookmarksopenlevel;
72 * Allows link text to break across lines.
73 * breaklinks boolean false
77 * The style of box around links; defaults to a box with lines of 1pt
78 * thickness, but the colorlinks option resets it to produce no border.
79 * pdfborder "0 0 1" / "0 0 0"
80 * Note that the color of link borders can be specified only as 3
81 * numbers in the range 0..1, giving an RGB color.
82 * You cannot use colors defined in TEX.
84 * We represent here only the last bit, there is no semantics in the
85 * first two. Morover the aim is not to represent the whole pdfborder,
86 * but just to deny the ugly boxes around pdf links.
90 * colorlinks boolean false
94 * Adds backlink text to the end of each item in the bibliography,
95 * as a list of section numbers.
96 * This can only work properly if there is a blank line after each
98 * backref boolean false
102 * Adds backlink text to the end of each item in the bibliography,
103 * as a list of page numbers.
104 * pagebackref boolean false
108 * Determines how the file is opening in Acrobat;
109 * the possibilities are None, UseThumbs (show thumbnails), UseOutlines
110 * (show bookmarks), and FullScreen.
111 * If no mode if explicitly chosen, but the bookmarks option is set,
112 * UseOutlines is used.
113 * pagemode text empty
115 * We currently implement only FullScreen, but all modes can be saved
116 * here, lyx format & latex writer is prepared.
117 * The only thing needed in such a case is wider Settings
118 * dialog -> PDFOptions.pagemode .
120 std::string pagemode;
122 * Flag indicating whether hyperref tries to derive the values for
123 * pdftitle and pdfauthor from \title and \author.
124 * pdfusetitle boolean false
126 * Note that we use true as default value instead. The option is also
127 * used in latex output only when title and author is not filled.
131 static const std::string pagemode_fullscreen;
133 * Additional parameters for hyperref given from user.
135 std::string quoted_options;
137 * Possible syntax check of users additional parameters here.
138 * Returns repaired string. For the time being only newlines
141 std::string quoted_options_check(std::string const str) const;
145 * Flag indicating whether user made some input into PDF preferences.
146 * We want to save options, when user decide to switch off PDF support
154 #endif // PDFOPTIONS_H