lyx_mirror/src/output_latex.h
Richard Heck b0097bcddb Introduce a new "RequiredArgs" tag for layouts. This functions much as
the OptionalArgs tag does and is implemented by the now misnamed
InsetOptArgs, except that its content gets wrapped in "{}" rather than
"[]". Required arguments do not actually have to be provided, but they
are always output. 

This will allow e.g. beamer's Block environment to be implemented
without ERT.

Documentation to follow.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@34591 a592a061-630c-0410-9148-cb99ea01b6c8
2010-06-04 21:50:08 +00:00

75 lines
2.1 KiB
C++

// -*- C++ -*-
/**
* \file output_latex.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef OUTPUT_LATEX_H
#define OUTPUT_LATEX_H
#include <utility>
#include "support/docstream.h"
#include "Paragraph.h"
#include "ParIterator.h"
#include "ParagraphList.h"
namespace lyx {
class Buffer;
class BufferParams;
class Encoding;
class Layout;
class Paragraph;
class OutputParams;
class TexRow;
class Text;
/// Export up to \p reqargs required arguments and
/// \p optargs optional ones. If not enough required
/// ones are given, we'll output: {}. The optional ones
/// must all come first.
int latexArgInsets(Paragraph const & par,
odocstream & os, OutputParams const & runparams,
unsigned int reqargs, unsigned int optargs);
/** Export \p paragraphs of buffer \p buf to LaTeX.
Don't use a temporary stringstream for \p os if the final output is
supposed to go to a file.
\sa Buffer::writeLaTeXSource for the reason.
*/
void latexParagraphs(Buffer const & buf,
Text const & text,
odocstream & ofs,
TexRow & texrow,
OutputParams const &,
std::string const & everypar = std::string());
/** Switch the encoding of \p os from runparams.encoding to \p newEnc if needed.
\p force forces this also within non-default or -auto encodings.
\return (did the encoding change?, number of characters written to \p os)
*/
std::pair<bool, int> switchEncoding(odocstream & os,
BufferParams const & bparams,
OutputParams const &, Encoding const & newEnc,
bool force = false);
/// FIXME: this should not be visible.
ParagraphList::const_iterator TeXOnePar(Buffer const & buf,
Text const & text,
ParagraphList::const_iterator pit,
odocstream & os, TexRow & texrow,
OutputParams const & runparams,
std::string const & everypar = std::string(),
int start_pos = -1, int end_pos = -1);
} // namespace lyx
#endif