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 LColor::color color() const;
214 Language const * language() const;
217 bool isRightToLeft() const;
220 bool isVisibleRightToLeft() const;
223 LyXFont & setFamily(LyXFont::FONT_FAMILY f);
225 LyXFont & setSeries(LyXFont::FONT_SERIES s);
227 LyXFont & setShape(LyXFont::FONT_SHAPE s);
229 LyXFont & setSize(LyXFont::FONT_SIZE s);
231 LyXFont & setEmph(LyXFont::FONT_MISC_STATE e);
233 LyXFont & setUnderbar(LyXFont::FONT_MISC_STATE u);
235 LyXFont & setNoun(LyXFont::FONT_MISC_STATE n);
237 LyXFont & setLatex(LyXFont::FONT_MISC_STATE l);
239 LyXFont & setColor(LColor::color c);
241 LyXFont & setLanguage(Language const * l);
243 /// Set family after LyX text format
244 LyXFont & setLyXFamily(string const &);
246 /// Set series after LyX text format
247 LyXFont & setLyXSeries(string const &);
249 /// Set shape after LyX text format
250 LyXFont & setLyXShape(string const &);
252 /// Set size after LyX text format
253 LyXFont & setLyXSize(string const &);
255 /// Returns misc flag after LyX text format
256 LyXFont::FONT_MISC_STATE setLyXMisc(string const &);
258 /// Sets color after LyX text format
259 LyXFont & setLyXColor(string const &);
261 /// Sets size after GUI name
262 LyXFont & setGUISize(string const &);
264 /// Returns size of font in LaTeX text notation
265 string latexSize() const;
267 /** Updates font settings according to request. If an
268 attribute is IGNORE, the attribute is left as it is. */
270 * When toggleall = true, all properties that matches the font in use
271 * will have the effect that the properties is reset to the
272 * default. If we have a text that is TYPEWRITER_FAMILY, and is
273 * update()'ed with TYPEWRITER_FAMILY, the operation will be as if
274 * a INHERIT_FAMILY was asked for. This is necessary for the
275 * toggle-user-defined-style button on the toolbar.
277 void update(LyXFont const & newfont,
278 Language const * default_lang,
279 bool toggleall = false);
281 /** Reduce font to fall back to template where possible.
282 Equal fields are reduced to INHERIT */
283 void reduce(LyXFont const & tmplt);
285 /// Realize font from a template (INHERIT are realized)
286 LyXFont & realize(LyXFont const & tmplt);
288 /// Is a given font fully resolved?
289 bool resolved() const;
291 /// Read a font specification from LyXLex. Used for layout files.
292 LyXFont & lyxRead(LyXLex &);
294 /// Writes the changes from this font to orgfont in .lyx format in file
295 void lyxWriteChanges(LyXFont const & orgfont, std::ostream &) const;
297 /** Writes the head of the LaTeX needed to change to this font.
298 Writes to string, the head of the LaTeX needed to change
299 to this font. Returns number of chars written. Base is the
300 font state active now.
302 int latexWriteStartChanges(std::ostream &, LyXFont const & base,
303 LyXFont const & prev) const;
305 /** Writes tha tail of the LaTeX needed to chagne to this font.
306 Returns number of chars written. Base is the font state we want
309 int latexWriteEndChanges(std::ostream &, LyXFont const & base,
310 LyXFont const & next) const;
312 /// Build GUI description of font state
313 string stateText(BufferParams * params) const;
316 LColor::color realColor() const;
320 bool operator==(LyXFont const & font1, LyXFont const & font2) {
321 return font1.bits == font2.bits &&
322 font1.lang == font2.lang;
327 bool operator!=(LyXFont const & font1, LyXFont const & font2) {
328 return !(font1 == font2);
331 /// compares two fonts, ignoring the setting of the Latex part.
332 bool equalExceptLatex(LyXFont const &) const;
334 /// Converts logical attributes to concrete shape attribute
335 LyXFont::FONT_SHAPE realShape() const;
340 bool operator==(FontBits const & fb1) const;
342 bool operator!=(FontBits const & fb1) const;
354 FONT_MISC_STATE emph;
356 FONT_MISC_STATE underbar;
358 FONT_MISC_STATE noun;
360 FONT_MISC_STATE latex;
365 Language const * lang;
368 static FontBits sane;
371 static FontBits inherit;
374 static FontBits ignore;
376 /// Updates a misc setting according to request
377 LyXFont::FONT_MISC_STATE setMisc(LyXFont::FONT_MISC_STATE newfont,
378 LyXFont::FONT_MISC_STATE org);
382 std::ostream & operator<<(std::ostream &, LyXFont::FONT_MISC_STATE);
389 lang = default_language;
394 LyXFont::LyXFont(LyXFont const & x)
402 LyXFont::LyXFont(LyXFont::FONT_INIT1)
405 lang = default_language;
410 LyXFont::LyXFont(LyXFont::FONT_INIT2)
413 lang = ignore_language;
418 LyXFont::LyXFont(LyXFont::FONT_INIT3)
421 lang = default_language;
424 LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l)
432 LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l)
440 LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l)
448 LyXFont & LyXFont::operator=(LyXFont const & x)
457 LyXFont::FONT_FAMILY LyXFont::family() const
464 LyXFont::FONT_SERIES LyXFont::series() const
471 LyXFont::FONT_SHAPE LyXFont::shape() const
478 LyXFont::FONT_SIZE LyXFont::size() const
485 LyXFont::FONT_MISC_STATE LyXFont::emph() const
492 LyXFont::FONT_MISC_STATE LyXFont::underbar() const
494 return bits.underbar;
499 LyXFont::FONT_MISC_STATE LyXFont::noun() const
506 LyXFont::FONT_MISC_STATE LyXFont::latex() const
513 LColor::color LyXFont::color() const
520 Language const * LyXFont::language() const
527 bool LyXFont::isRightToLeft() const
529 return lang->RightToLeft();
534 bool LyXFont::isVisibleRightToLeft() const
536 return (lang->RightToLeft() && latex() != ON);
541 LyXFont & LyXFont::setFamily(LyXFont::FONT_FAMILY f)
549 LyXFont & LyXFont::setSeries(LyXFont::FONT_SERIES s)
557 LyXFont & LyXFont::setShape(LyXFont::FONT_SHAPE s)
565 LyXFont & LyXFont::setSize(LyXFont::FONT_SIZE s)
573 LyXFont & LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
581 LyXFont & LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
589 LyXFont & LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
596 LyXFont & LyXFont::setLatex(LyXFont::FONT_MISC_STATE l)
604 LyXFont & LyXFont::setColor(LColor::color c)
612 LyXFont & LyXFont::setLanguage(Language const * l)