// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+/**
+ * \file bufferparams.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ====================================================== */
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
#include "LString.h"
-#include "lyxlex.h"
#include "vspace.h"
#include "Spacing.h"
#include "Bullet.h"
+#include "lyxtextclass.h"
+#include "LaTeXFeatures.h"
+#include "texrow.h"
+#include "author.h"
+#include "paper.h"
+#include "BranchList.h"
+
#include "insets/insetquotes.h"
-#include "layout.h"
-#include <boost/array.hpp>
+#include <boost/array.hpp>
+#include <vector>
+class LyXLex;
+class LatexFeatures;
+class TexRow;
struct Language;
/** Buffer parameters.
*/
class BufferParams {
public:
- ///
- enum PAPER_SIZE {
- ///
- PAPER_DEFAULT,
- ///
- PAPER_USLETTER,
- ///
- PAPER_LEGALPAPER,
- ///
- PAPER_EXECUTIVEPAPER,
- ///
- PAPER_A3PAPER,
- ///
- PAPER_A4PAPER,
- ///
- PAPER_A5PAPER,
- ///
- PAPER_B5PAPER
- };
- ///
- enum PAPER_PACKAGES {
- ///
- PACKAGE_NONE,
- ///
- PACKAGE_A4,
- ///
- PACKAGE_A4WIDE,
- ///
- PACKAGE_WIDEMARGINSA4
- };
- ///
- enum VMARGIN_PAPER_TYPE {
- ///
- VM_PAPER_DEFAULT,
- ///
- VM_PAPER_CUSTOM,
- ///
- VM_PAPER_USLETTER,
- ///
- VM_PAPER_USLEGAL,
- ///
- VM_PAPER_USEXECUTIVE,
- ///
- VM_PAPER_A3,
- ///
- VM_PAPER_A4,
- ///
- VM_PAPER_A5,
- ///
- VM_PAPER_B3,
- ///
- VM_PAPER_B4,
- ///
- VM_PAPER_B5
- };
///
enum PARSEP {
///
PARSEP_SKIP
};
///
- enum PAPER_ORIENTATION {
- ///
- ORIENTATION_PORTRAIT,
- ///
- ORIENTATION_LANDSCAPE
- };
- ///
BufferParams();
+ /// read a header token, if unrecognised, return it or an unknown class name
+ string const readToken(LyXLex & lex, string const & token);
+
///
void writeFile(std::ostream &) const;
+ /** \returns true if the babel package is used (interogates
+ the BufferParams and a LyXRC variable).
+ This returned value can then be passed to the insets...
+ */
+ bool writeLaTeX(std::ostream &, LaTeXFeatures &, TexRow &) const;
+
+ ///
+ void setPaperStuff();
+
///
void useClassDefaults();
+ ///
+ bool hasClassDefaults() const;
+
///
VSpace const & getDefSkip() const { return defskip; }
/** Wether paragraphs are separated by using a indent like in
articles or by using a little skip like in letters.
*/
- PARSEP paragraph_separation;
+ PARSEP paragraph_separation;
///
- InsetQuotes::quote_language quotes_language;
+ InsetQuotes::quote_language quotes_language;
///
- InsetQuotes::quote_times quotes_times;
+ InsetQuotes::quote_times quotes_times;
///
- string fontsize;
+ string fontsize;
///
- LyXTextClassList::size_type textclass;
+ lyx::textclass_type textclass;
+ ///
+ LyXTextClass const & getLyXTextClass() const;
/* this are for the PaperLayout */
/// the general papersize (papersize2 or paperpackage
- char papersize; // add apprip. signedness
- /// the selected Geometry papersize
- char papersize2; // add approp. signedness
- /// a special paperpackage .sty-file
- char paperpackage; // add approp. signedness
- ///
- PAPER_ORIENTATION orientation; // add approp. signedness
- ///
- bool use_geometry;
- ///
- string paperwidth;
- ///
- string paperheight;
- ///
- string leftmargin;
- ///
- string topmargin;
- ///
- string rightmargin;
- ///
- string bottommargin;
- ///
- string headheight;
- ///
- string headsep;
- ///
- string footskip;
-
- /* some LaTeX options */
+ PAPER_SIZE papersize;
+ /// the selected Geometry papersize
+ VMARGIN_PAPER_TYPE papersize2;
+ /// a special paperpackage .sty-file
+ PAPER_PACKAGES paperpackage;
+ ///
+ PAPER_ORIENTATION orientation;
+ ///
+ bool use_geometry;
+ ///
+ string paperwidth;
+ ///
+ string paperheight;
+ ///
+ string leftmargin;
+ ///
+ string topmargin;
+ ///
+ string rightmargin;
+ ///
+ string bottommargin;
+ ///
+ string headheight;
+ ///
+ string headsep;
+ ///
+ string footskip;
+
+ /* some LaTeX options */
/// The graphics driver
string graphicsDriver;
///
///
int tocdepth;
///
- string language;
- ///
- Language const * language_info;
+ Language const * language;
+ /// BranchList:
+ BranchList branchlist;
///
string inputenc;
///
///
string pagestyle;
///
- array<Bullet, 4> temp_bullets;
+ boost::array<Bullet, 4> temp_bullets;
///
- array<Bullet, 4> user_defined_bullets;
+ boost::array<Bullet, 4> user_defined_bullets;
///
void readPreamble(LyXLex &);
///
void readLanguage(LyXLex &);
///
void readGraphicsDriver(LyXLex &);
+
+ /// use AMS package, not, or auto
+ enum AMS {
+ AMS_OFF,
+ AMS_AUTO,
+ AMS_ON
+ };
+ AMS use_amsmath;
+ ///
+ bool use_natbib;
///
- bool use_amsmath;
+ bool use_numerical_citations;
+ /// revision tracking for this buffer ?
+ bool tracking_changes;
/// Time ago we agreed that this was a buffer property [ale990407]
- string parentname;
+ string parentname;
+ ///
+ bool compressed;
+
+ /// map of the file's author IDs to buffer author IDs
+ std::vector<int> author_map;
+ ///
+ string const dvips_options() const;
+ ///
+ string const paperSizeName() const;
+
private:
+ /// the author list
+ AuthorList authorlist;
+
///
friend class Buffer;
/** This is the amount of space used for paragraph_separation "skip",
projects / lyx.git / blobdiff