lyx_mirror/src/frontends/font_metrics.h
Lars Gullik Bjønnes 13349032cb ws changes
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@5758 a592a061-630c-0410-9148-cb99ea01b6c8
2002-12-01 22:59:25 +00:00

88 lines
2.4 KiB
C++

// -*- C++ -*-
/**
* \file font_metrics.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author unknown
* \author John Levon
*
* Full author contact details are available in file CREDITS
*/
#ifndef FONT_METRICS_H
#define FONT_METRICS_H
#include "LString.h"
class LyXFont;
/**
* A namespace holding helper functions for determining
* the screen dimensions of fonts.
*
* The geometry is the standard typographical geometry,
* as follows :
*
* --------------+------------------<maxAscent
* | |
* <-------> (right bearing)
* <-> (left bearing)
* char ascent>___ |
* ^ oooo | oooo
* origin>____ | oo oo | oo oo
* \| oo oo | oo oo
* --------------+---ooooo--|--oooo-<baseline
* | oo |
* char | oo oo |
* descent>______| oooo |
* <- width ->
* --------------+----------+-------<maxDescent
*
*/
namespace font_metrics {
/// return the maximum ascent of the font
int maxAscent(LyXFont const & f);
/// return the maximum descent of the font
int maxDescent(LyXFont const & f);
/// return the ascent of the char in the font
int ascent(char c, LyXFont const & f);
/// return the descent of the char in the font
int descent(char c, LyXFont const & f);
/// return the left bearing of the char in the font
int lbearing(char c, LyXFont const & f);
/// return the right bearing of the char in the font
int rbearing(char c, LyXFont const & f);
/// return the width of the string in the font
int width(char const * s, size_t n, LyXFont const & f);
/// return the width of the char in the font
inline int width(char c, LyXFont const & f) {
return width(&c, 1, f);
}
/// return the width of the string in the font
inline int width(string const & s, LyXFont const & f) {
if (s.empty()) return 0;
return width(s.data(), s.length(), f);
}
/// FIXME ??
int signedWidth(string const & s, LyXFont const & f);
/**
* fill in width,ascent,descent with the values for the
* given string in the font.
*/
void rectText(string const & str, LyXFont const & font,
int & width,
int & ascent,
int & descent);
/**
* fill in width,ascent,descent with the values for the
* given string in the font for a button.
*/
void buttonText(string const & str, LyXFont const & font,
int & width,
int & ascent,
int & descent);
}
#endif // FONT_METRICS_H