Haiku Book: Update BFont docs.

This commit is contained in:
Augustin Cavalier
2019-01-23 23:10:33 -05:00
parent d9b872d03c
commit ad7cab8751
+16 -8
View File
@@ -1,13 +1,13 @@
/* /*
* Copyright 2013 Haiku, Inc. All rights reserved. * Copyright 2013-2019 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License. * Distributed under the terms of the MIT License.
* *
* Authors: * Authors:
* John Scipione, [email protected] * John Scipione, [email protected]
* *
* Corresponds to: * Corresponds to:
* headers/os/interface/Font.h hrev45178 * headers/os/interface/Font.h hrev52784
* src/kits/interface/Font.cpp hrev45178 * src/kits/interface/Font.cpp hrev52784
*/ */
@@ -1313,8 +1313,10 @@
\brief Returns whether or not the font is fixed-width and contains both \brief Returns whether or not the font is fixed-width and contains both
full and half-width characters. full and half-width characters.
\note This was left unimplemented as of R5. It is a way to work with both A full-and-half-fixed font is one that contains characters of only
Kanji and Roman characters in the same fixed-width font. two sizes, so that CJK languages can be properly supported.
\note This was unimplemented in BeOS R5, but is implemented in Haiku.
\since BeOS R4 \since BeOS R4
*/ */
@@ -1335,15 +1337,20 @@
\brief Gets a \c unicode_block object that identifies the Unicode blocks \brief Gets a \c unicode_block object that identifies the Unicode blocks
supported by this font face and family. supported by this font face and family.
\attention Currently unimplemented, returns an empty \a unicode_block
object.
\returns A \c unicode_block object containing supported Unicode blocks. \returns A \c unicode_block object containing supported Unicode blocks.
\since BeOS R4 \since BeOS R4
*/ */
/*!
\fn bool BFont::IncludesBlock(uint32 start, uint32 end) const
\brief Gets whether the font includes the specified Unicode block.
\since Haiku R1
*/
/*! /*!
\fn font_file_format BFont::FileFormat() const \fn font_file_format BFont::FileFormat() const
\brief Gets whether the font is a TrueType™ or PostScript™ Type1 font. \brief Gets whether the font is a TrueType™ or PostScript™ Type1 font.
@@ -1385,6 +1392,7 @@
supplied truncation \a mode. supplied truncation \a mode.
The following truncation modes are supported: The following truncation modes are supported:
- \c B_NO_TRUNCATION Does nothing.
- \c B_TRUNCATE_BEGINNING Truncate from the beginning of the string. - \c B_TRUNCATE_BEGINNING Truncate from the beginning of the string.
- \c B_TRUNCATE_MIDDLE Truncate from the middle of the string. - \c B_TRUNCATE_MIDDLE Truncate from the middle of the string.
- \c B_TRUNCATE_END Truncate from the end of the string. - \c B_TRUNCATE_END Truncate from the end of the string.