mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-02 14:01:10 +00:00
1ef605f625
blank lines may be inadvertently output. This is achieved by using two
special iomanip-like variables (breakln and safebreakln) in the lyx::
namespace. When they are inserted in the stream, a newline is output
only if not already at the beginning of a line. The difference between
breakln and safebreakln is that, if needed, the former outputs '\n'
and the latter "%\n".
In future, the new class will also be used for counting the number of
newlines issued. Even if the infractrure for doing that is already in
place, the counting is essentially still done the old way.
There are still places in the code where the functionality of the
class could be used, most probably. ATM, it is used for InsetTabular,
InsetListings, InsetFloat, and InsetText.
The Comment and GreyedOut insets required a special treatment and a
new InsetLayout parameter (Display) has been introduced. The default
for Display is "true", meaning that the corresponding latex
environment is of "display" type, i.e., it stands on its own, whereas
"false" means that the contents appear inline with the text. The
latter is the case for both Comment and GreyedOut insets.
Mostly, the only visible effects on latex exports should be the
disappearing of some redundant % chars and the appearing/disappearing
of null {} latex groups after a comment or lyxgreyedout environments
(they are related to the presence or absence of a space immediately
after those environments), as well as the fact that math environments
are now started on their own lines.
As a last thing, only the latex code between \begin{document} and
\end{document} goes through the new class, the preamble being directly
output through odocstream, as usual.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37360 a592a061-630c-0410-9148-cb99ea01b6c8
247 lines
5.7 KiB
C++
247 lines
5.7 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file InsetLayout.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Martin Vermeer
|
|
* \author Richard Heck
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef INSET_LAYOUT_H
|
|
#define INSET_LAYOUT_H
|
|
|
|
#include "ColorCode.h"
|
|
#include "FontInfo.h"
|
|
|
|
#include "support/docstring.h"
|
|
|
|
#include <set>
|
|
#include <string>
|
|
|
|
namespace lyx {
|
|
|
|
class Lexer;
|
|
class TextClass;
|
|
|
|
///
|
|
class InsetLayout {
|
|
public:
|
|
///
|
|
InsetLayout();
|
|
///
|
|
enum InsetDecoration {
|
|
CLASSIC,
|
|
MINIMALISTIC,
|
|
CONGLOMERATE,
|
|
DEFAULT
|
|
};
|
|
///
|
|
enum InsetLyXType {
|
|
NOLYXTYPE,
|
|
CHARSTYLE,
|
|
CUSTOM,
|
|
ELEMENT,
|
|
END,
|
|
STANDARD
|
|
};
|
|
///
|
|
enum InsetLaTeXType {
|
|
NOLATEXTYPE,
|
|
COMMAND,
|
|
ENVIRONMENT,
|
|
ILT_ERROR
|
|
};
|
|
///
|
|
bool read(Lexer & lexrc, TextClass const & tclass);
|
|
///
|
|
docstring name() const { return name_; }
|
|
///
|
|
void setName(docstring const & n) { name_ = n; }
|
|
///
|
|
InsetLyXType lyxtype() const { return lyxtype_; }
|
|
///
|
|
docstring labelstring() const { return labelstring_; }
|
|
///
|
|
bool contentaslabel() const { return contentaslabel_; }
|
|
///
|
|
InsetDecoration decoration() const { return decoration_; }
|
|
///
|
|
InsetLaTeXType latextype() const { return latextype_; }
|
|
///
|
|
std::string latexname() const { return latexname_; }
|
|
///
|
|
std::string latexparam() const { return latexparam_; }
|
|
///
|
|
FontInfo font() const { return font_; }
|
|
///
|
|
FontInfo labelfont() const { return labelfont_; }
|
|
///
|
|
ColorCode bgcolor() const { return bgcolor_; }
|
|
///
|
|
docstring preamble() const { return preamble_; }
|
|
///
|
|
docstring counter() const { return counter_; }
|
|
///
|
|
docstring refprefix() const { return refprefix_; }
|
|
/// The tag enclosing all the material in this inset. Default is "span".
|
|
std::string const & htmltag() const;
|
|
/// Additional attributes for inclusion with the start tag. Default (if
|
|
/// a tag is provided) is: class="name".
|
|
std::string const & htmlattr() const;
|
|
/// Tag for individual paragraphs in the inset. Default is none.
|
|
std::string const & htmlinnertag() const { return htmlinnertag_; }
|
|
/// Attributes for that tag. Default (if a tag is provided) is:
|
|
/// class="name_inner".
|
|
std::string const & htmlinnerattr() const;
|
|
/// A label for this environment, possibly including a reference
|
|
/// to a counter. E.g., for footnote, it might be:
|
|
/// \arabic{footnote}
|
|
/// No default.
|
|
/// FIXME Could we get this from the layout?
|
|
std::string const & htmllabel() const { return htmllabel_; }
|
|
///
|
|
inline std::string htmllabeltag() const { return "span"; }
|
|
///
|
|
std::string htmllabelattr() const
|
|
{ return "class=\"" + defaultCSSClass() + "_label\""; }
|
|
/// CSS associated with this inset.
|
|
docstring htmlstyle() const;
|
|
/// Additional material for the header.
|
|
docstring htmlpreamble() const { return htmlpreamble_; }
|
|
/// Whether this inset represents a "block" of material, i.e., a set
|
|
/// of paragraphs of its own (true), or should be run into the previous
|
|
/// paragraph (false). Examples:
|
|
/// For branches, this is false.
|
|
/// For footnotes, this is true.
|
|
/// Defaults to true.
|
|
bool htmlisblock() const { return htmlisblock_; }
|
|
///
|
|
std::set<std::string> requires() const { return requires_; }
|
|
///
|
|
bool isMultiPar() const { return multipar_; }
|
|
///
|
|
bool forcePlainLayout() const { return forceplain_; }
|
|
///
|
|
bool allowParagraphCustomization() const { return custompars_; }
|
|
///
|
|
bool isPassThru() const { return passthru_; }
|
|
///
|
|
bool parbreakIsNewline() const { return parbreakisnewline_; }
|
|
///
|
|
bool isNeedProtect() const { return needprotect_; }
|
|
///
|
|
bool isFreeSpacing() const { return freespacing_; }
|
|
///
|
|
bool isKeepEmpty() const { return keepempty_; }
|
|
///
|
|
bool forceLTR() const { return forceltr_; }
|
|
///
|
|
bool isInToc() const { return intoc_; }
|
|
///
|
|
bool spellcheck() const { return spellcheck_; }
|
|
///
|
|
bool resetsFont() const { return resetsfont_; }
|
|
///
|
|
bool isDisplay() const { return display_; }
|
|
private:
|
|
///
|
|
void makeDefaultCSS() const;
|
|
///
|
|
std::string defaultCSSClass() const;
|
|
///
|
|
std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; }
|
|
///
|
|
docstring name_;
|
|
/**
|
|
* This is only used (at present) to decide where to put them on the menus.
|
|
* Values are 'charstyle', 'custom' (things that by default look like a
|
|
* footnote), 'element' (docbook), 'standard'.
|
|
*/
|
|
InsetLyXType lyxtype_;
|
|
///
|
|
docstring labelstring_;
|
|
///
|
|
bool contentaslabel_;
|
|
///
|
|
InsetDecoration decoration_;
|
|
///
|
|
InsetLaTeXType latextype_;
|
|
///
|
|
std::string latexname_;
|
|
///
|
|
std::string latexparam_;
|
|
///
|
|
FontInfo font_;
|
|
///
|
|
FontInfo labelfont_;
|
|
///
|
|
ColorCode bgcolor_;
|
|
///
|
|
docstring counter_;
|
|
///
|
|
docstring preamble_;
|
|
///
|
|
docstring refprefix_;
|
|
///
|
|
mutable std::string htmltag_;
|
|
///
|
|
mutable std::string htmlattr_;
|
|
///
|
|
std::string htmlinnertag_;
|
|
///
|
|
mutable std::string htmlinnerattr_;
|
|
///
|
|
std::string htmllabel_;
|
|
///
|
|
docstring htmlstyle_;
|
|
/// Cache for default CSS info for this inset.
|
|
mutable docstring htmldefaultstyle_;
|
|
/// Cache for default CSS class.
|
|
mutable std::string defaultcssclass_;
|
|
/// Whether to force generation of default CSS even if some is given.
|
|
/// False by default.
|
|
bool htmlforcecss_;
|
|
///
|
|
docstring htmlpreamble_;
|
|
///
|
|
bool htmlisblock_;
|
|
///
|
|
std::set<std::string> requires_;
|
|
///
|
|
bool multipar_;
|
|
///
|
|
bool custompars_;
|
|
///
|
|
bool forceplain_;
|
|
///
|
|
bool passthru_;
|
|
///
|
|
bool parbreakisnewline_;
|
|
///
|
|
bool freespacing_;
|
|
///
|
|
bool keepempty_;
|
|
///
|
|
bool forceltr_;
|
|
///
|
|
bool needprotect_;
|
|
/// should the contents be written to TOC strings?
|
|
bool intoc_;
|
|
/// check spelling of this inset?
|
|
bool spellcheck_;
|
|
///
|
|
bool resetsfont_;
|
|
///
|
|
bool display_;
|
|
};
|
|
|
|
///
|
|
InsetLayout::InsetLyXType translateLyXType(std::string const & str);
|
|
|
|
} // namespace lyx
|
|
|
|
#endif
|