2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2000 The LyX Team.
10 * ====================================================== */
25 // It might happen that locale.h defines ON and OFF. This is not good
26 // for us, since we use these names below. But of course this is due
27 // to some old compilers. Than is broken when it comes to C++ scoping.
28 #include "gettext.h" // so that we are sure tht it won't be included
44 /** The value INHERIT_* means that the font attribute is
45 inherited from the layout. In the case of layout fonts, the
46 attribute is inherited from the default font.
47 The value IGNORE_* is used with LyXFont::update() when the
48 attribute should not be changed.
52 ROMAN_FAMILY, // fontstruct rely on this to be 0
68 MEDIUM_SERIES, // fontstruct rely on this to be 0
80 UP_SHAPE, // fontstruct rely on this to be 0
96 SIZE_TINY, // fontstruct rely on this to be 0
125 /// Used for emph, underbar, noun and latex toggles
126 enum FONT_MISC_STATE {
139 /// Trick to overload constructor and make it megafast
158 // LyXFont x(LyXFont ...) and LyXFont x = LyXFont ...
159 LyXFont(LyXFont const & x);
161 /// Shortcut initialization
163 LyXFont(LyXFont::FONT_INIT1);
164 /// Shortcut initialization
166 LyXFont(LyXFont::FONT_INIT2);
167 /// Shortcut initialization
169 LyXFont(LyXFont::FONT_INIT3);
170 /// Shortcut initialization
171 LyXFont(LyXFont::FONT_INIT1, Language const * l);
172 /// Shortcut initialization
173 LyXFont(LyXFont::FONT_INIT2, Language const * l);
174 /// Shortcut initialization
175 LyXFont(LyXFont::FONT_INIT3, Language const * l);
177 /// LyXFont x, y; x = y;
178 LyXFont & operator=(LyXFont const & x);
180 /// Decreases font size by one
183 /// Increases font size by one
187 FONT_FAMILY family() const;
190 FONT_SERIES series() const;
193 FONT_SHAPE shape() const;
196 FONT_SIZE size() const;
199 FONT_MISC_STATE emph() const;
202 FONT_MISC_STATE underbar() const;
205 FONT_MISC_STATE noun() const;
208 FONT_MISC_STATE latex() const;
211 FONT_MISC_STATE number() const;
214 LColor::color color() const;
217 Language const * language() const;
220 bool isRightToLeft() const;
223 bool isVisibleRightToLeft() const;
226 LyXFont & setFamily(LyXFont::FONT_FAMILY f);
228 LyXFont & setSeries(LyXFont::FONT_SERIES s);
230 LyXFont & setShape(LyXFont::FONT_SHAPE s);
232 LyXFont & setSize(LyXFont::FONT_SIZE s);
234 LyXFont & setEmph(LyXFont::FONT_MISC_STATE e);
236 LyXFont & setUnderbar(LyXFont::FONT_MISC_STATE u);
238 LyXFont & setNoun(LyXFont::FONT_MISC_STATE n);
240 LyXFont & setLatex(LyXFont::FONT_MISC_STATE l);
242 LyXFont & setNumber(LyXFont::FONT_MISC_STATE n);
244 LyXFont & setColor(LColor::color c);
246 LyXFont & setLanguage(Language const * l);
248 /// Set family after LyX text format
249 LyXFont & setLyXFamily(string const &);
251 /// Set series after LyX text format
252 LyXFont & setLyXSeries(string const &);
254 /// Set shape after LyX text format
255 LyXFont & setLyXShape(string const &);
257 /// Set size after LyX text format
258 LyXFont & setLyXSize(string const &);
260 /// Returns misc flag after LyX text format
261 LyXFont::FONT_MISC_STATE setLyXMisc(string const &);
263 /// Sets color after LyX text format
264 LyXFont & setLyXColor(string const &);
266 /// Returns size of font in LaTeX text notation
267 string const latexSize() const;
269 /** Updates font settings according to request.
270 If an attribute is IGNORE, the attribute is left as it is.
271 When toggleall = true, all properties that matches the font in use
272 will have the effect that the properties is reset to the
273 default. If we have a text that is TYPEWRITER_FAMILY, and is
274 update()'ed with TYPEWRITER_FAMILY, the operation will be as if
275 a INHERIT_FAMILY was asked for. This is necessary for the
276 toggle-user-defined-style button on the toolbar.
278 void update(LyXFont const & newfont,
279 Language const * default_lang,
280 bool toggleall = false);
282 /** Reduce font to fall back to template where possible.
283 Equal fields are reduced to INHERIT */
284 void reduce(LyXFont const & tmplt);
286 /// Realize font from a template (INHERIT are realized)
287 LyXFont & realize(LyXFont const & tmplt);
289 /// Is a given font fully resolved?
290 bool resolved() const;
292 /// Read a font specification from LyXLex. Used for layout files.
293 LyXFont & lyxRead(LyXLex &);
295 /// Writes the changes from this font to orgfont in .lyx format in file
296 void lyxWriteChanges(LyXFont const & orgfont, std::ostream &) const;
298 /** Writes the head of the LaTeX needed to change to this font.
299 Writes to string, the head of the LaTeX needed to change
300 to this font. Returns number of chars written. Base is the
301 font state active now.
303 int latexWriteStartChanges(std::ostream &, LyXFont const & base,
304 LyXFont const & prev) const;
306 /** Writes tha tail of the LaTeX needed to chagne to this font.
307 Returns number of chars written. Base is the font state we want
310 int latexWriteEndChanges(std::ostream &, LyXFont const & base,
311 LyXFont const & next) const;
313 /// Build GUI description of font state
314 string const stateText(BufferParams * params) const;
317 LColor::color realColor() const;
321 bool operator==(LyXFont const & font1, LyXFont const & font2);
325 bool operator!=(LyXFont const & font1, LyXFont const & font2);
327 /// compares two fonts, ignoring the setting of the Latex part.
328 bool equalExceptLatex(LyXFont const &) const;
330 /// Converts logical attributes to concrete shape attribute
331 LyXFont::FONT_SHAPE realShape() const;
336 bool operator==(FontBits const & fb1) const;
338 bool operator!=(FontBits const & fb1) const;
350 FONT_MISC_STATE emph;
352 FONT_MISC_STATE underbar;
354 FONT_MISC_STATE noun;
356 FONT_MISC_STATE latex;
361 Language const * lang;
363 FONT_MISC_STATE number_;
366 static FontBits sane;
369 static FontBits inherit;
372 static FontBits ignore;
374 /// Updates a misc setting according to request
375 LyXFont::FONT_MISC_STATE setMisc(LyXFont::FONT_MISC_STATE newfont,
376 LyXFont::FONT_MISC_STATE org);
380 std::ostream & operator<<(std::ostream &, LyXFont::FONT_MISC_STATE);
384 bool operator==(LyXFont const & font1, LyXFont const & font2) {
385 return font1.bits == font2.bits &&
386 font1.lang == font2.lang &&
387 font1.number_ == font2.number_;
392 bool operator!=(LyXFont const & font1, LyXFont const & font2) {
393 return !(font1 == font2);
401 lang = default_language;
407 LyXFont::LyXFont(LyXFont const & x)
416 LyXFont::LyXFont(LyXFont::FONT_INIT1)
419 lang = default_language;
425 LyXFont::LyXFont(LyXFont::FONT_INIT2)
428 lang = ignore_language;
434 LyXFont::LyXFont(LyXFont::FONT_INIT3)
437 lang = default_language;
443 LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l)
452 LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l)
461 LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l)
470 LyXFont & LyXFont::operator=(LyXFont const & x)
480 LyXFont::FONT_FAMILY LyXFont::family() const
487 LyXFont::FONT_SERIES LyXFont::series() const
494 LyXFont::FONT_SHAPE LyXFont::shape() const
501 LyXFont::FONT_SIZE LyXFont::size() const
508 LyXFont::FONT_MISC_STATE LyXFont::emph() const
515 LyXFont::FONT_MISC_STATE LyXFont::underbar() const
517 return bits.underbar;
522 LyXFont::FONT_MISC_STATE LyXFont::noun() const
529 LyXFont::FONT_MISC_STATE LyXFont::latex() const
536 LColor::color LyXFont::color() const
543 Language const * LyXFont::language() const
550 LyXFont::FONT_MISC_STATE LyXFont::number() const
557 bool LyXFont::isRightToLeft() const
559 return lang->RightToLeft();
564 bool LyXFont::isVisibleRightToLeft() const
566 return (lang->RightToLeft() && latex() != ON && number() != ON);
571 LyXFont & LyXFont::setFamily(LyXFont::FONT_FAMILY f)
579 LyXFont & LyXFont::setSeries(LyXFont::FONT_SERIES s)
587 LyXFont & LyXFont::setShape(LyXFont::FONT_SHAPE s)
595 LyXFont & LyXFont::setSize(LyXFont::FONT_SIZE s)
603 LyXFont & LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
611 LyXFont & LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
619 LyXFont & LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
626 LyXFont & LyXFont::setLatex(LyXFont::FONT_MISC_STATE l)
634 LyXFont & LyXFont::setColor(LColor::color c)
642 LyXFont & LyXFont::setLanguage(Language const * l)
650 LyXFont & LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)