* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LAYOUT_H
#define LAYOUT_H
-#include "Font.h"
+#include "FontInfo.h"
#include "LayoutEnums.h"
#include "Spacing.h"
#include "support/docstring.h"
+#include <set>
+#include <string>
+
namespace lyx {
+class Language;
class Lexer;
class TextClass;
public:
///
Layout();
+ /// is this layout a default layout created for an unknown layout
+ bool isUnknown() const { return unknown_; }
+ void setUnknown(bool unknown) { unknown_ = unknown; }
/// Reads a layout definition from file
+ /// \return true on success.
bool read(Lexer &, TextClass const &);
///
void readAlign(Lexer &);
///
void readSpacing(Lexer &);
///
- docstring const & name() const;
+ docstring const & name() const { return name_; };
///
- void setName(docstring const & n);
+ void setName(docstring const & n) { name_ = n; }
///
- docstring const & obsoleted_by() const;
+ docstring const & obsoleted_by() const { return obsoleted_by_; }
///
- docstring const & depends_on() const;
+ docstring const & depends_on() const { return depends_on_; }
///
std::string const & latexname() const { return latexname_; }
///
+ void setLatexName(std::string const & n) { latexname_ = n; }
+ ///
docstring const & labelstring() const { return labelstring_; }
///
docstring const & endlabelstring() const { return endlabelstring_; }
///
+ docstring const & category() const { return category_; }
+ ///
docstring const & preamble() const { return preamble_; }
+ /// Get language dependent macro definitions needed for this layout
+ /// for language \p lang
+ docstring const langpreamble(Language const * lang) const;
+ /// Get language and babel dependent macro definitions needed for
+ /// this layout for language \p lang
+ docstring const babelpreamble(Language const * lang) const;
+ ///
+ std::set<std::string> const & requires() const { return requires_; }
///
std::string const & latexparam() const { return latexparam_; }
///
std::string const & labeltag() const { return labeltag_; }
///
std::string const & itemtag() const { return itemtag_; }
+ ///
+ std::string const & htmltag() const { return htmltag_; }
+ ///
+ std::string const & htmlattr() const { return htmlattr_; }
+ ///
+ std::string const & htmlitem() const { return htmlitem_; }
+ ///
+ std::string const & htmlitemattr() const { return htmlitemattr_; }
+ ///
+ std::string const & htmllabel() const { return htmllabel_; }
+ ///
+ std::string const & htmllabelattr() const { return htmllabelattr_; }
+ ///
+ bool htmllabelfirst() const { return htmllabelfirst_; }
+ ///
+ docstring const & htmlstyle() const { return htmlstyle_; }
+ ///
+ docstring const & htmlpreamble() const { return htmlpreamble_; }
///
docstring const & labelstring_appendix() const {
return labelstring_appendix_;
}
+ ///
+ bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
+ ///
+ bool isCommand() const { return latextype == LATEX_COMMAND; }
+ ///
+ bool isEnvironment() const {
+ return latextype == LATEX_ENVIRONMENT
+ || latextype == LATEX_BIB_ENVIRONMENT
+ || latextype == LATEX_ITEM_ENVIRONMENT
+ || latextype == LATEX_LIST_ENVIRONMENT;
+ }
+
+ ///
+ bool operator==(Layout const &) const;
+ ///
+ bool operator!=(Layout const & rhs) const
+ { return !(*this == rhs); }
+
+ ////////////////////////////////////////////////////////////////
+ // members
+ ////////////////////////////////////////////////////////////////
/** Default font for this layout/environment.
The main font for this kind of environment. If an attribute has
- Font::INHERITED_*, it means that the value is specified by
+ INHERITED_*, it means that the value is specified by
the defaultfont for the entire layout. If we are nested, the
font is inherited from the font in the environment one level
- up until the font is resolved. The values Font::IGNORE_*
- and Font::TOGGLE are illegal here.
+ up until the font is resolved. The values :IGNORE_*
+ and FONT_TOGGLE are illegal here.
*/
- Font font;
+ FontInfo font;
/** Default font for labels.
Interpretation the same as for font above
*/
- Font labelfont;
+ FontInfo labelfont;
/** Resolved version of the font for this layout/environment.
This is a resolved version the default font. The font is resolved
against the defaultfont of the entire layout.
*/
- Font resfont;
+ FontInfo resfont;
/** Resolved version of the font used for labels.
This is a resolved version the label font. The font is resolved
against the defaultfont of the entire layout.
*/
- Font reslabelfont;
+ FontInfo reslabelfont;
/// Text that dictates how wide the left margin is on the screen
docstring leftmargin;
bool free_spacing;
///
bool pass_thru;
- /**
- * Whether this layout was declared with "Environment xxx" as opposed
- * to "Style xxx". This is part of some unfinished generic environment
- * handling (see also InsetEnvironment) started by Andre. No layout
- * that is shipped with LyX has this flag set.
- * Don't confuse this with isEnvironment()!
- */
- bool is_environment;
/// show this in toc
int toclevel;
/// special value of toclevel for non-section layouts
static const int NOT_IN_TOC;
- /// for new environment insets
- std::string latexheader;
- /// for new environment insets
- std::string latexfooter;
- /// for new environment insets
- std::string latexparagraph;
/** true when the fragile commands in the paragraph need to be
\protect'ed. */
bool needprotect;
/// true when empty paragraphs should be kept.
bool keepempty;
- ///
- bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
- ///
- bool isCommand() const { return latextype == LATEX_COMMAND; }
- ///
- bool isEnvironment() const {
- return latextype == LATEX_ENVIRONMENT
- || latextype == LATEX_BIB_ENVIRONMENT
- || latextype == LATEX_ITEM_ENVIRONMENT
- || latextype == LATEX_LIST_ENVIRONMENT;
- }
/// Type of LaTeX object
LatexType latextype;
/// Does this object belong in the title part of the document?
/// until it has proper support for the caption inset (JMarc)
static Layout * forCaption();
+
private:
/// Name of the layout/paragraph environment
docstring name_;
+ /// LaTeX name for environment
+ std::string latexname_;
+
+ /** Is this layout the default layout for an unknown layout? If
+ * so, its name will be displayed as xxx (unknown).
+ */
+ bool unknown_;
+
/** Name of an layout that has replaced this layout.
This is used to rename a layout, while keeping backward
compatibility
*/
docstring depends_on_;
- /// LaTeX name for environment
- std::string latexname_;
/// Label string. "Abstract", "Reference", "Caption"...
docstring labelstring_;
///
std::string labeltag_;
/// Internal tag to surround the item text in a list)
std::string itemtag_;
+ /// Tag for HTML output, e.g., h2.
+ std::string htmltag_;
+ /// Additional attributes for inclusion with the start tag,
+ /// e.g.: class='section'.
+ std::string htmlattr_;
+ /// Tag for individual paragraphs in an environment. In lists, this
+ /// would be something like "li". But it also needs to be set for
+ /// quotation, e.g., since the paragraphs in a quote need to be
+ /// in "p" tags.
+ std::string htmlitem_;
+ /// Attributes for htmlitem_
+ std::string htmlitemattr_;
+ /// Tag for labels, of whatever sort. One use for this is in setting
+ /// descriptions, in which case it would be: dt. Another use is to
+ /// customize the display of, say, the auto-generated label for
+ /// sections (in that case, it might be: span).
+ std::string htmllabel_;
+ /// Attributes for the label.
+ std::string htmllabelattr_;
+ /// Whether to put the label before the item, or within the item.
+ /// I.e., do we have (true):
+ /// <label>...</label><item>...</item>
+ /// or instead (false):
+ /// <item><label>...</label>...</item>
+ /// The latter is the default.
+ bool htmllabelfirst_;
+ /// CSS information needed by this layout.
+ docstring htmlstyle_;
+ /// Any other info for the HTML header.
+ docstring htmlpreamble_;
+ /// This is the `category' for this layout. The following are
+ /// recommended basic categories: FrontMatter, BackMatter, MainText,
+ /// Section, Starred, List, Theorem.
+ docstring category_;
/// Macro definitions needed for this layout
docstring preamble_;
+ /// Language dependent macro definitions needed for this layout
+ docstring langpreamble_;
+ /// Language and babel dependent macro definitions needed for this layout
+ docstring babelpreamble_;
+ /// Packages needed for this layout
+ std::set<std::string> requires_;
};
-
} // namespace lyx
#endif
projects / lyx.git / blobdiff