source file of the GNU LilyPond music typesetter
- (c) 2005--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ (c) 2005--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "font-metric.hh"
2, 0, 0,
(SCM font, SCM name),
"Return a stencil from @var{font} for the glyph named @var{name}."
- " @var{font} must be available as an AFM file. If the glyph"
- " is not available, return @code{#f}.")
+ " If the glyph is not available, return an empty stencil.\n"
+ "\n"
+ "Note that this command can only be used to access glyphs from"
+ " fonts loaded with @code{ly:system-font-load}; currently, this"
+ " means either the Emmentaler or Aybabtu fonts, corresponding"
+ " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+ " respectively.")
{
Font_metric *fm = unsmob_metrics (font);
LY_ASSERT_SMOB (Font_metric, font, 1);
2, 0, 0,
(SCM font, SCM index),
"Retrieve a stencil for the glyph numbered @var{index}"
- " in @var{font}.")
+ " in @var{font}.\n"
+ "\n"
+ "Note that this command can only be used to access glyphs from"
+ " fonts loaded with @code{ly:system-font-load}; currently, this"
+ " means either the Emmentaler or Aybabtu fonts, corresponding"
+ " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+ " respectively.")
{
Font_metric *fm = unsmob_metrics (font);
LY_ASSERT_SMOB (Font_metric, font, 1);
LY_DEFINE (ly_font_glyph_name_to_index, "ly:font-glyph-name-to-index",
2, 0, 0,
(SCM font, SCM name),
- "Return the index for @var{name} in @var{font}.")
+ "Return the index for @var{name} in @var{font}.\n"
+ "\n"
+ "Note that this command can only be used to access glyphs from"
+ " fonts loaded with @code{ly:system-font-load}; currently, this"
+ " means either the Emmentaler or Aybabtu fonts, corresponding"
+ " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+ " respectively.")
{
Font_metric *fm = unsmob_metrics (font);
LY_ASSERT_SMOB (Font_metric, font, 1);
LY_DEFINE (ly_font_index_to_charcode, "ly:font-index-to-charcode",
2, 0, 0,
(SCM font, SCM index),
- "Return the character code for @var{index} in @var{font}.")
+ "Return the character code for @var{index} in @var{font}.\n"
+ "\n"
+ "Note that this command can only be used to access glyphs from"
+ " fonts loaded with @code{ly:system-font-load}; currently, this"
+ " means either the Emmentaler or Aybabtu fonts, corresponding"
+ " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+ " respectively.")
{
Font_metric *fm = unsmob_metrics (font);
LY_ASSERT_SMOB (Font_metric, font, 1);
LY_DEFINE (ly_font_glyph_name_to_charcode, "ly:font-glyph-name-to-charcode",
2, 0, 0,
(SCM font, SCM name),
- "Return the character code for glyph @var{name} in @var{font}.")
+ "Return the character code for glyph @var{name} in @var{font}.\n"
+ "\n"
+ "Note that this command can only be used to access glyphs from"
+ " fonts loaded with @code{ly:system-font-load}; currently, this"
+ " means either the Emmentaler or Aybabtu fonts, corresponding"
+ " to the font encodings @code{fetaMusic} and @code{fetaBraces},"
+ " respectively.")
{
Font_metric *fm = unsmob_metrics (font);
LY_ASSERT_SMOB (Font_metric, font, 1);