4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
12 * Full author contact details are available in file CREDITS.
18 #include "ColorCode.h"
21 #include "support/strfwd.h"
36 explicit Font(FontInfo = sane_font, Language const * l = 0);
39 FontInfo & fontInfo() { return bits_; }
41 FontInfo const & fontInfo() const { return bits_; }
43 Language const * language() const { return lang_; }
45 void setMisspelled(bool misspelled) { misspelled_ = misspelled; }
47 bool isMisspelled() const { return misspelled_; }
49 bool isRightToLeft() const;
51 bool isVisibleRightToLeft() const;
53 void setLanguage(Language const * l);
55 /// Returns size of font in LaTeX text notation
56 std::string const latexSize() const;
58 /** Updates font settings according to request.
59 If an attribute is IGNORE, the attribute is left as it is.
60 When toggleall = true, all properties that matches the font in use
61 will have the effect that the properties is reset to the
62 default. If we have a text that is TYPEWRITER_FAMILY, and is
63 update()'ed with TYPEWRITER_FAMILY, the operation will be as if
64 a INHERIT_FAMILY was asked for. This is necessary for the
65 toggle-user-defined-style button on the toolbar.
67 void update(Font const & newfont,
68 Language const * default_lang,
69 bool toggleall = false);
71 /// Writes the changes from this font to orgfont in .lyx format in file
72 void lyxWriteChanges(Font const & orgfont, std::ostream &) const;
74 /** Writes the head of the LaTeX needed to change to this font.
75 Writes to string, the head of the LaTeX needed to change
76 to this font. Returns number of chars written. Base is the
77 font state active now.
79 int latexWriteStartChanges(odocstream &, BufferParams const & bparams,
80 OutputParams const & runparams,
82 Font const & prev) const;
84 /** Writes the tail of the LaTeX needed to change to this font.
85 Returns number of chars written. Base is the font state we want
88 int latexWriteEndChanges(odocstream &, BufferParams const & bparams,
89 OutputParams const & runparams,
92 bool const & closeLanguage = true) const;
95 /// Build GUI description of font state
96 docstring const stateText(BufferParams * params) const;
99 void validate(LaTeXFeatures & features) const;
103 bool operator==(Font const & font1, Font const & font2);
106 std::ostream & operator<<(std::ostream & os, Font const & font);
108 /// Set \param data using \param font and \param toggle.
109 std::string toString(bool toggle) const;
111 /// Set \param font and \param toggle using \param data. Return success.
112 bool fromString(std::string const & data, bool & toggle);
118 Language const * lang_;
122 /// Did latexWriteStartChanges open an encoding environment?
123 mutable bool open_encoding_;
129 bool operator==(Font const & font1, Font const & font2)
131 return font1.bits_ == font2.bits_ && font1.lang_ == font2.lang_
132 && font1.misspelled_ == font2.misspelled_;
137 bool operator!=(Font const & font1, Font const & font2)
139 return !(font1 == font2);
142 /** Returns the current freefont, encoded as a std::string to be passed to the
143 * frontends. Implemented in Text3.cpp.
145 std::string const freefont2string();