i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Big docs cleanup.

Browse Source 
* Fixed headers including:
  - All rights reserved not All Rights Reserved.
  - name, [email protected] not name <[email protected]>
  - tabs and spaces
  - Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.
This commit is contained in:
John Scipione
2013-02-07 02:01:19 -05:00
parent 8cf4ba89b6
commit 820dca4df6
109 changed files with 6698 additions and 5170 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/interface/Font.dox
+105 -25
View File
@@ -1,9 +1,10 @@
/*
* Copyright 2013 Haiku inc.
* Copyright 2013 Haiku Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Documentation by:
* John Scipione <[email protected]>
* Authors:
* John Scipione, [email protected]
*
* Corresponds to:
* /trunk/headers/os/interface/Font.h hrev45178
* /trunk/src/kits/interface/Font.cpp hrev45178
@@ -12,6 +13,8 @@
/*!
\file Font.h
\ingroup interface
\ingroup libbe
\brief BFont class definition, unicode_block class definition, and
font-related struct and enum definitions.
*/
@@ -19,12 +22,14 @@
/*!
\var B_CHAR_SPACING
Position each character without adjustment. Best mode for printing.
*/
/*!
\var B_STRING_SPACING
Optimizes the position of each character within it's space. Collisions
are unlikely but characters may touch each other. Best mode to use when
the screen needs to match what appears on the printed page.
@@ -33,6 +38,7 @@
/*!
\var B_BITMAP_SPACING
The widths of the characters are chosen so that they never collide and
rarely touch. Best mode for drawing small amounts of text.
*/
@@ -40,225 +46,267 @@
/*!
\var B_FIXED_SPACING
Positions characters at a constant width. Best mode for fixed-width fonts.
*/
/*!
\enum font_direction
\ingroup interface
\ingroup libbe
Determines the direction of the text rendered by the font,
left-to-right or right-to-left.
*/
/*!
\var font_direction B_FONT_LEFT_TO_RIGHT
Left to right.
*/
/*!
\var font_direction B_FONT_RIGHT_TO_LEFT
Right to left.
*/
/*!
\var B_DISABLE_ANTIALIASING
Disable antialiasing. Used by BFont::Flags() and BFont::SetFlags().
*/
/*!
\var B_FORCE_ANTIALIASING
Force antialiasing. Used by BFont::Flags() and BFont::SetFlags().
*/
/*!
\var B_TRUNCATE_END
Truncate from the end of the string.
*/
/*!
\var B_TRUNCATE_BEGINNING
Truncate from the beginning of the string.
*/
/*!
\var B_TRUNCATE_MIDDLE
Truncate from the middle of the string.
*/
/*!
\var B_TRUNCATE_SMART
Truncate while keeping each string unique.
*/
/*!
\var B_UNICODE_UTF8
UTF-8 font encoding.
*/
/*!
\var B_ISO_8859_1
ISO 8859-1 aka Latin 1 "Western European" font encoding.
*/
/*!
\var B_ISO_8859_2
ISO 8859-2 aka Latin 2 "Eastern European" font encoding.
*/
/*!
\var B_ISO_8859_3
ISO 8859-3 aka Latin 3 "South European" font encoding.
*/
/*!
\var B_ISO_8859_4
ISO 8859-4 aka Latin 4 "Northern European" font encoding.
*/
/*!
\var B_ISO_8859_5
ISO 8859-5 "Latin/Cyrillic" font encoding.
*/
/*!
\var B_ISO_8859_6
ISO 8859-6 "Latin/Arabic" font encoding.
*/
/*!
\var B_ISO_8859_7
ISO 8859-7 "Latin/Greek" font encoding.
*/
/*!
\var B_ISO_8859_8
ISO 8859-8 "Latin/Hebrew" font encoding.
*/
/*!
\var B_ISO_8859_9
ISO 8859-9 aka Latin 5 "Latin/Turkish" font encoding.
*/
/*!
\var B_ISO_8859_10
ISO 8859-10 aka Latin 6 "Nordic" font encoding.
*/
/*!
\var B_MACINTOSH_ROMAN
Macintosh Roman font encoding.
*/
/*!
\var B_HAS_TUNED_FONT
flags for get_font_family() and get_font_style()
Flags for get_font_family() and get_font_style()
*/
/*!
\var B_IS_FIXED
flags for get_font_family() and get_font_style()
*/
/*!
\var B_ITALIC_FACE
Italic font face flag.
*/
/*!
\var B_UNDERSCORE_FACE
Underscore font face flag.
*/
/*!
\var B_NEGATIVE_FACE
Negative font face flag.
*/
/*!
\var B_OUTLINED_FACE
Outline font face flag.
*/
/*!
\var B_STRIKEOUT_FACE
Strikeout font face flag.
*/
/*!
\var B_BOLD_FACE
Bold font face flag.
*/
/*!
\var B_REGULAR_FACE
Regular font face flag.
*/
/*!
\var B_CONDENSED_FACE
Condensed font face flag. Not in BeOS 5.
*/
/*!
\var B_LIGHT_FACE
Light font face flag. Not in BeOS 5.
*/
/*!
\var B_HEAVY_FACE
Heavy font face flag. Not in BeOS 5.
*/
/*!
\enum font_metric_mode
Font metric mode, screen or printing.
*/
/*!
\var font_metric_mode B_SCREEN_METRIC
Screen font metric mode.
*/
/*!
\var font_metric_mode B_PRINTING_METRIC
Printing font metric mode.
*/
/*!
\enum font_file_format
\ingroup interface
\ingroup libbe
Font file format, TrueType™ or PostScript™ Type1.
\see BFont::FileFormat()
@@ -266,17 +314,21 @@
/*!
\var font_file_format B_TRUETYPE_WINDOWS
TrueType™ font file format.
*/
/*!
\var font_file_format B_POSTSCRIPT_TYPE1_WINDOWS
PostScript™ Type1 font file format.
*/
/*!
\class unicode_block
\ingroup interface
\ingroup libbe
\brief Describes the blocks of Unicode characters supported by a font.
\see BFont::Blocks()
@@ -392,6 +444,8 @@
/*!
\struct edge_info
\ingroup interface
\ingroup libbe
\brief The distance that a character outline is inset from its escapement
boundaries.
@@ -404,20 +458,24 @@
/*!
\var edge_info::left
\brief The distance that the character outline is inset from the left
escapement boundary.
The distance that the character outline is inset from the left
escapement boundary.
*/
/*!
\var edge_info::right
\brief The distance that the character outline is inset from the right
escapement boundary.
The distance that the character outline is inset from the right
escapement boundary.
*/
/*!
\struct font_height
\ingroup interface
\ingroup libbe
\brief The amount of vertical space surrounding a character.
\see BFont::GetHeight()
@@ -426,24 +484,29 @@
/*!
\var font_height::ascent
\brief The distance characters can ascend above the baseline.
The distance characters can ascend above the baseline.
*/
/*!
\var font_height::descent
\brief The distance characters can descend below the baseline.
The distance characters can descend below the baseline.
*/
/*!
\var font_height::leading
\brief The distance between lines, descent above to ascent below.
The distance between lines, descent above to ascent below.
*/
/*!
\struct escapement_delta
\ingroup interface
\ingroup libbe
\brief The amount of horizontal space surrounding a character.
Escapements need to be multiplied by the font size to get the correct
@@ -455,60 +518,72 @@
/*!
\var escapement_delta::nonspace
\brief The amount of space surrounding a character with a visible glyph.
The amount of space surrounding a character with a visible glyph.
*/
/*!
\var escapement_delta::space
\brief The amount of space surrounding a whitespace character, for example
\c B_TAB and \c B_SPACE.
The amount of space surrounding a whitespace character, for example
\c B_TAB and \c B_SPACE.
*/
/*!
\struct font_cache_info
\ingroup interface
\ingroup libbe
\brief Font cache parameters.
*/
/*!
\var font_cache_info::sheared_font_penalty
\brief Sheared font penalty.
Sheared font penalty.
*/
/*!
\var font_cache_info::rotated_font_penalty
\brief Rotated font penalty.
Rotated font penalty.
*/
/*!
\var font_cache_info::oversize_threshold
\brief Oversize threshold.
Oversize threshold.
*/
/*!
\var font_cache_info::oversize_penalty
\brief Oversize penalty.
Oversize penalty.
*/
/*!
\var font_cache_info::cache_size
\brief Cache size.
Cache size.
*/
/*!
\var font_cache_info::spacing_size_threshold
\brief Spacing size threshold.
Spacing size threshold.
*/
/*!
\struct tuned_font_info
\ingroup interface
\ingroup libbe
\brief Tuning information of fonts used to make it look better when
displayed on-screen.
@@ -519,30 +594,35 @@
/*!
\var tuned_font_info::size
\brief Font size.
Font size.
*/
/*!
\var tuned_font_info::shear
\brief Font shear.
Font shear.
*/
/*!
\var tuned_font_info::rotation
\brief Font rotation.
Font rotation.
*/
/*!
\var tuned_font_info::flags
\brief Font flags.
Font flags.
*/
/*!
\var tuned_font_info::face
\brief Font face.
Font face.
*/