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.
24 // Write functions need to use odostream instead of ostream before
25 // we can use docstring instead of string.
27 /// Options for PDF generation
31 PDFOptions() { clear(); }
32 /// check whether user added any settings for hyperref
34 /// output to lyx header
35 void writeFile(std::ostream &) const;
36 /// output to tex header
37 void writeLaTeX(OutputParams &, otexstream &,
38 bool hyperref_already_provided) const;
39 /// read tokens from lyx header
40 std::string readToken(Lexer &lex, std::string const & token);
41 /// set implicit settings for hyperref
55 * A set of Acrobat bookmarks are written, in a manner similar to the
57 * bookmarks boolean true
61 * If Acrobat bookmarks are requested, include section numbers.
62 * bookmarksnumbered boolean false
64 bool bookmarksnumbered;
66 * If Acrobat bookmarks are requested, show them with all the subtrees
68 * bookmarksopen boolean false
72 * Level (\maxdimen) to which bookmarks are open
73 * bookmarksopenlevel parameter
75 int bookmarksopenlevel;
77 * Allows link text to break across lines.
78 * breaklinks boolean false
82 * The style of box around links; defaults to a box with lines of 1pt
83 * thickness, but the colorlinks option resets it to produce no border.
84 * pdfborder "0 0 1" / "0 0 0"
85 * Note that the color of link borders can be specified only as 3
86 * numbers in the range 0..1, giving an RGB color.
87 * You cannot use colors defined in TEX.
89 * We represent here only the last bit, there is no semantics in the
90 * first two. Morover the aim is not to represent the whole pdfborder,
91 * but just to deny the ugly boxes around pdf links.
95 * colorlinks boolean false
99 * Adds backlink text to the end of each item in the bibliography,
100 * as a list of section/slide/page numbers.
101 * This can only work properly if there is a blank line after each
103 * backref string empty(="section"), "false", "section", "slide", "page"
105 * Internally we use false/section/slide/pages. See also bug 5340.
109 * Determines how the file is opening in Acrobat;
110 * the possibilities are None, UseThumbs (show thumbnails), UseOutlines
111 * (show bookmarks), and FullScreen.
112 * If no mode if explicitly chosen, but the bookmarks option is set,
113 * UseOutlines is used.
114 * pagemode text empty
116 * We currently implement only FullScreen, but all modes can be saved
117 * here, lyx format & latex writer is prepared.
118 * The only thing needed in such a case is wider Settings
119 * dialog -> PDFOptions.pagemode .
121 std::string pagemode;
123 * Flag indicating whether hyperref tries to derive the values for
124 * pdftitle and pdfauthor from \title and \author.
125 * pdfusetitle boolean false
127 * Note that we use true as default value instead. The option is also
128 * used in latex output only when title and author is not filled.
132 static const std::string pagemode_fullscreen;
134 * Additional parameters for hyperref given from user.
136 std::string quoted_options;
138 * Possible syntax check of users additional parameters here.
139 * Returns repaired string. For the time being only newlines
142 std::string quoted_options_check(std::string const & str) const;
147 #endif // PDFOPTIONS_H