Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
22da33b202
haiku/docs/user/interface/Font.dox

1795 lines
39 KiB
Plaintext
Raw Normal View History

Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*
Docs: Put a comma in Haiku, Inc. in the copyright.
2014-06-04 19:57:42 +04:00
* Copyright 2013 Haiku, Inc. All rights reserved.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
* Distributed under the terms of the MIT License.
*
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
* Authors:
* John Scipione, jscipione@gmail.com
*
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
* Corresponds to:
Remove remaining /trunk/ before file references.
2013-02-08 06:19:06 +04:00
* headers/os/interface/Font.h hrev45178
* src/kits/interface/Font.cpp hrev45178
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\file Font.h
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
\ingroup libbe
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief BFont class definition, unicode_block class definition, and
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
font-related struct and enum definitions.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_CHAR_SPACING
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Position each character without adjustment. Best mode for printing.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_STRING_SPACING
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
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.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_BITMAP_SPACING
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
The widths of the characters are chosen so that they never collide and
rarely touch. Best mode for drawing small amounts of text.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_FIXED_SPACING
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Positions characters at a constant width. Best mode for fixed-width fonts.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\enum font_direction
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Determines the direction of the text rendered by the font,
left-to-right or right-to-left.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
add a newline
2013-03-17 01:04:44 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\var font_direction B_FONT_LEFT_TO_RIGHT
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Left to right.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\var font_direction B_FONT_RIGHT_TO_LEFT
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Right to left.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_DISABLE_ANTIALIASING
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Disable antialiasing. Used by BFont::Flags() and BFont::SetFlags().
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_FORCE_ANTIALIASING
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Force antialiasing. Used by BFont::Flags() and BFont::SetFlags().
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_TRUNCATE_END
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
Truncate from the end of the string.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_TRUNCATE_BEGINNING
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Truncate from the beginning of the string.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_TRUNCATE_MIDDLE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Truncate from the middle of the string.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_TRUNCATE_SMART
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Truncate while keeping each string unique.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_UNICODE_UTF8
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
UTF-8 font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_1
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
ISO 8859-1 aka Latin 1 "Western European" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_2
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
ISO 8859-2 aka Latin 2 "Eastern European" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_3
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
ISO 8859-3 aka Latin 3 "South European" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_4
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
ISO 8859-4 aka Latin 4 "Northern European" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_5
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
ISO 8859-5 "Latin/Cyrillic" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_6
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
ISO 8859-6 "Latin/Arabic" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_7
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
ISO 8859-7 "Latin/Greek" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_8
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
ISO 8859-8 "Latin/Hebrew" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_9
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
ISO 8859-9 aka Latin 5 "Latin/Turkish" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ISO_8859_10
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
ISO 8859-10 aka Latin 6 "Nordic" font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_MACINTOSH_ROMAN
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Macintosh Roman font encoding.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_HAS_TUNED_FONT
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Indicates that the font has been adjusted to look good on the screen.
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_IS_FIXED
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Indicates that the font is non-proportional.
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_ITALIC_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Italic font face flag.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_UNDERSCORE_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Underscore font face flag.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_NEGATIVE_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Negative font face flag.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_OUTLINED_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Outline font face flag.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_STRIKEOUT_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Strikeout font face flag.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_BOLD_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Bold font face flag.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_REGULAR_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Regular font face flag.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_CONDENSED_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Condensed font face flag.
\since Haiku R1
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_LIGHT_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Light font face flag.
\since Haiku R1
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\var B_HEAVY_FACE
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Heavy font face flag.
\since Haiku R1
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\enum font_metric_mode
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Font metric mode, screen or printing.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\var font_metric_mode B_SCREEN_METRIC
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Screen font metric mode.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\var font_metric_mode B_PRINTING_METRIC
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
Printing font metric mode.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\enum font_file_format
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Font file format, TrueType™ or PostScript™ Type1.
\see BFont::FileFormat()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\var font_file_format B_TRUETYPE_WINDOWS
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
TrueType™ font file format.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\var font_file_format B_POSTSCRIPT_TYPE1_WINDOWS
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
PostScript™ Type1 font file format.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\class unicode_block
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
\ingroup libbe
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Describes the blocks of Unicode characters supported by a font.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\see BFont::Blocks()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn unicode_block::unicode_block()
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Construct a \c unicode_block and set block data to 0.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
You must initialize the block data before before using this object.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn unicode_block::unicode_block(uint64 block2, uint64 block1)
\brief Construct a \c unicode_block object and initialize it with the
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
supplied Unicode block range.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param block2 End block.
\param block1 Begin block.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn bool unicode_block::Includes(const unicode_block& block) const
\brief Determines if \a block is a subset of the \c unicode_block object.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\param block The Unicode block to check.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\returns Whether or not \a block is a subset of the \c unicode_block
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
object.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\retval true \a block is a subset of the current \c unicode_block.
\retval false \a block is NOT a subset of the current \c unicode_block.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\name Operators
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
//! @{
/*!
\fn unicode_block unicode_block::operator&(const unicode_block& block) const
\brief Creates a new \c unicode_block object that is the intersection of
\a block and the \c unicode_block object.
\param block The Unicode block to intersect with.
\returns The intersection of \a block and the \c unicode_block object.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn unicode_block unicode_block::operator|(const unicode_block& block) const
\brief Creates a new \c unicode_block object that is the union of \a block
and the \c unicode_block object.
\param block The Unicode block to form a union with.
\returns The union of \a block and the \c unicode_block object.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn unicode_block& unicode_block::operator=(const unicode_block& block)
\brief Copies \a block data into the left-hand side object.
\param block The unicode block to copy from.
\returns A copy of \a block.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn bool unicode_block::operator==(const unicode_block& block) const
\brief Determines if the block object are exactly equal.
\param block The unicode block to compare against.
\returns \c true if the block object are exactly equal, \c false
otherwise.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
/*!
\fn bool unicode_block::operator!=(const unicode_block& block) const
\brief Determines if the block object are not equal.
\param block The unicode block to compare against.
\returns \c true if the block object are NOT equal, \c false
if the block objects are exactly equal.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
//! @}
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\struct edge_info
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
\ingroup libbe
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief The distance that a character outline is inset from its escapement
boundaries.
Edge values, like escapements, need to be multiplied by the font size to
get the correct value for the font.
\see BFont::GetEdges()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\var edge_info::left
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
The distance that the character outline is inset from the left
escapement boundary.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\var edge_info::right
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
The distance that the character outline is inset from the right
escapement boundary.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\struct font_height
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
\ingroup libbe
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief The amount of vertical space surrounding a character.
\see BFont::GetHeight()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\var font_height::ascent
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
The distance characters can ascend above the baseline.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\var font_height::descent
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
The distance characters can descend below the baseline.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\var font_height::leading
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
The distance between lines, descent above to ascent below.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\struct escapement_delta
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
\ingroup libbe
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
\brief A struct that allows you to specify extra horizontal space to surround
each character with.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Escapements need to be multiplied by the font size to get the correct
value for the font.
\see BFont::GetEscapements()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\var escapement_delta::nonspace
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
The amount of horizontal space to surround a visible glyph character with.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\var escapement_delta::space
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
The amount of horizontal space to surround a whitespace character with, for
example \c B_TAB or \c B_SPACE.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\struct font_cache_info
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
\ingroup libbe
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\brief Font cache parameters.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var font_cache_info::sheared_font_penalty
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Sheared font penalty.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var font_cache_info::rotated_font_penalty
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Rotated font penalty.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var font_cache_info::oversize_threshold
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Oversize threshold.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var font_cache_info::oversize_penalty
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Oversize penalty.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var font_cache_info::cache_size
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Cache size.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var font_cache_info::spacing_size_threshold
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Spacing size threshold.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\struct tuned_font_info
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
\ingroup interface
\ingroup libbe
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Tuning information of fonts used to make it look better when
displayed on-screen.
\see BFont::GetTunedInfo()
\see BFont::CountTuned()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var tuned_font_info::size
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Font size.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var tuned_font_info::shear
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Font shear.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var tuned_font_info::rotation
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Font rotation.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var tuned_font_info::flags
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Font flags.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\var tuned_font_info::face
Big docs cleanup. * Fixed headers including: - All rights reserved not All Rights Reserved. - name, email@domain.com not name <email@domain.com> - 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.
2013-02-07 06:05:00 +04:00
Font face.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn int32 count_font_families()
\brief Gets the number of installed font families
\return The number of installed font families
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn int32 count_font_styles(font_family family)
\brief Gets the number of styles available for a font family.
\return The number of styles available for a font family.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn status_t get_font_family(int32 index, font_family *_name,
uint32 *_flags)
\brief Retrieves the family name at the specified index.
\param index Unique font identifier code.
\param _name font_family String to receive the name of the family.
\param _flags if non-<tt>NULL</tt>, the values of the flags \c IS_FIXED
and \c B_HAS_TUNED_FONT are returned.
\return A status code, \c B_OK on success or an error code.
\retval B_BAD_VALUE \a _name is \c NULL.
\retval B_ERROR \a index does not correspond to a font family.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn status_t get_font_style(font_family family, int32 index,
font_style *_name, uint32 *_flags)
\brief Retrieves the family name at the specified index.
\param family The font family.
\param index Unique font identifier code.
\param _name string to receive the name of the family.
\param _flags if non-<tt>NULL</tt>, the values of the flags \c IS_FIXED
and \c B_HAS_TUNED_FONT are returned
\return A status code, \c B_OK on success or an error code.
\retval B_ERROR \a index does not correspond to a font style.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn status_t get_font_style(font_family family, int32 index,
font_style *_name, uint16 *_face, uint32 *_flags)
\brief Retrieves the family name at the specified index.
The face value returned by this function is not very reliable. At the same
time, the value returned should be fairly reliable, returning the proper
flag for 90%-99% of font names.
\param family The font family.
\param index Unique font identifier code.
\param _name String to receive the name of the family.
\param _face recipient of font face value, such as \c B_REGULAR_FACE.
\param _flags if non-<tt>NULL</tt>, the values of the flags \c IS_FIXED
and \c B_HAS_TUNED_FONT are returned.
\return A status code, \c B_OK on success or an error code.
\retval B_ERROR \a index does not correspond to a font style.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn bool update_font_families(bool checkOnly)
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Updates the font families list.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\param checkOnly Parameter is ignored.
\return \c true if the font list has changed, \c false if not.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\class BFont
\ingroup interface
\ingroup libbe
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Represents a typeface including it's family, style and size.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
The Interface Kit provides three prebuilt BFont objects which can be used
but not modified.
- \c const BFont* \c be_plain_font A plain font used by many controls.
- \c const BFont* \c be_bold_font A bold font used by titles.
- \c const BFont* \c be_fixed_font A fixed-width font.
A BFont object does nothing on it's own but is used in combination with
a view or control. Here is an example of creating a BFont object from a
system font and assigning it to a view:
\code
BFont font(be_plain_font);
font.SetSize(12.0);
font.SetEncoding(B_ISO_8859_1);
view->SetFont(&font);
\endcode
You may also create a BFont object from a view, modify it and reassign it
back to the view like this:
\code
BFont font;
view->GetFont(&font);
font.SetFace(B_ITALIC_FACE);
font.SetSpacing(B_CHAR_SPACING);
myView->SetFont(&font);
\endcode
You can change the way a font renders with the SetFamilyAndStyle(),
SetFamilyAndFace(), SetSize(), SetShear(), SetRotation(),
SetFalseBoldWidth(), SetSpacing(), SetEncoding(), SetFace(), and
SetFlags() methods.
More information about the space taken up by a font can be determined
by querying a BFont object using the following methods:
StringWidth(), GetStringWidths() GetEscapements(), GetEdges(),
GetHeight(), BoundingBox() GetBoundingBoxesAsGlyphs(),
GetBoundingBoxesAsString(), and GetBoundingBoxesForStrings().
You can also perform intelligent string truncation with the
TruncateString() and GetTruncatedStrings() methods.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn BFont::BFont()
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Creates a BFont object initialized to \c be_plain_font.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see BView::GetFont()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\fn BFont::BFont(const BFont& font)
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\brief Creates and initializes a BFont object from another BFont object.
\param font The BFont object to initialize from.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\fn BFont::BFont(const BFont* font)
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\brief Creates and initializes a BFont object from a pointer to a BFont
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
object.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\param font The pointer to a BFont object to initialize from.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\fn BFont::BFont(const BFont* font)
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\brief Creates and initializes a BFont object from a pointer to a BFont
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
object.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\param font The pointer to a BFont object to initialize from.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn status_t BFont::SetFamilyAndStyle(const font_family family,
const font_style style)
\brief Sets the font's family and style all at once.
\param family Font family to set.
\param style Font style to set.
\returns A status code, \c B_OK on success or an error code.
\retval B_BAD_VALUE \a family is \c NULL and \a style is \c NULL.
\retval B_NAME_NOT_FOUND Family or style do not exist.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\fn void BFont::SetFamilyAndStyle(uint32 code)
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\brief Sets the font's family and style from a font identifier.
\param code Unique font identifier obtained from the server.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn status_t BFont::SetFamilyAndFace(const font_family family, uint16 face)
\brief Sets the font's family and face all at once.
\param family Font family to set.
\param face Font face to set.
\note To comply with the BeBook, this function will only set valid values,
i.e. passing a nonexistent family will cause only the face to be set.
Additionally, if a particular face does not exist in a family, the
closest match will be chosen.
Minor update use fixed font for B_OK
2013-01-19 11:51:31 +04:00
\returns A status code, \c B_OK on success or an error code.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\retval B_ERROR Family does not exists or face has an invalid value.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn void BFont::SetSize(float size)
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Sets the font size.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\param size The point size to set the font to.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn void BFont::SetShear(float shear)
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Sets the angle in degrees relative to the baseline.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
The default shear is 90.0° measured counterclockwise. The shear
range is from 45.0° to 135.0°.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param shear The shear in degrees to set the font to.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn void BFont::SetRotation(float rotation)
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Sets the font rotation from the baseline in degrees.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
The default baseline is 0° and rotates counterclockwise. Rotation is not
supported by BTextView.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param rotation The rotation in degrees to set the font to.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
/*!
\fn void BFont::SetFalseBoldWidth(float width)
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Sets the false bold width.
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
\param width The false bold width to set.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since Haiku R1
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
/*!
\fn void BFont::SetSpacing(uint8 spacing)
\brief Sets how characters are horizontally spaced relative to each other.
- \c B_CHAR_SPACING Position each character without adjustment. Best mode
for printing. Characters may collide or overlap at small font sizes.
- \c 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. Adding new characters requires the entire string to
be redrawn.
- \c 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. Character widths are integral values. Spacing on screen will
not match spacing used by \c B_CHAR_SPACING mode for printing.
- \c B_FIXED_SPACING Positions characters at a constant width. Must be
used with fixed-width fonts otherwise \c B_CHAR_SPACING mode is used.
All characters have an identical integral escapement.
\c B_STRING_SPACING and \c B_BITMAP_SPACING modes are relevant only for
font sizes from 7.0pt to 18.0pt, above and below that range
\c B_CHAR_SPACING produces nicer results. \c B_CHAR_SPACING is also always
used for rotated or sheared text and when antialiasing is disabled.
\param spacing The spacing mode to set.
\see BView::DrawString()
\see GetEscapements()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::SetEncoding(uint8 encoding)
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Sets the character encoding of the font for example
\c B_UNICODE_UTF8 or \c B_ISO_8859_1.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
The following character encodings are supported:
- \c B_UNICODE_UTF8
- \c B_ISO_8859_1 aka Latin 1 aka "Western European".
- \c B_ISO_8859_2 aka Latin 2 aka "Eastern European".
- \c B_ISO_8859_3 aka Latin 3 aka "South European".
- \c B_ISO_8859_4 aka Latin 4 aka "Northern European".
- \c B_ISO_8859_5 aka "Latin/Cyrillic".
- \c B_ISO_8859_6 aka "Latin/Arabic".
- \c B_ISO_8859_7 aka "Latin/Greek".
- \c B_ISO_8859_8 aka "Latin/Hebrew".
- \c B_ISO_8859_9 aka Latin 5 aka "Latin/Turkish".
- \c B_ISO_8859_10 aka Latin 6 aka "Nordic".
- \c B_MACINTOSH_ROMAN
BFont docs: Update SetEncoding() with some new info
2013-08-26 05:36:50 +04:00
UTF-8 is the standard encoding used by classes in the Interface Kit. It
is part of the Unicode® standard and allows Haiku to represent characters
from all over the world while maintaining backwards compatibility with
7-bit ASCII codes.
Each of the encodings extend the ASCII codes and differ from each other
only when the highest bit is set to 1, in other words, the value is
greater than 127. Furthermore each of the encodings except for UTF-8
are represented by a single byte and consequently encompass a limited set
of characters. Most of the encodings are in the ISO/IEC 8859 family of
character codes with the notable exception of Macintosh Roman which is
the standard encoding used by the classic Mac OS®.
If the value of the first byte of a UTF-8 character is greater than 127
it indicates that the character is a multibyte character and therefore you
must look at the next byte (and possibly the third byte, or rarely even
forth byte) to get the whole character.
Setting the character encoding on a view determines how BView::DrawString()
interprets the values passed to it and also how BView::KeyDown() interprets
the values representing the keys that the user presses.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\param encoding The character encoding to set the font to.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::SetFace(uint16 face)
\brief Sets the font face according to the flags set by \a face.
The following font face flags are supported:
- \c B_ITALIC_FACE Characters are slanted to the right.
- \c B_UNDERSCORE_FACE Characters are underlined.
- \c B_NEGATIVE_FACE High and low colors are reversed when drawing
characters.
- \c B_OUTLINED_FACE Characters are drawn hollowed out.
- \c B_STRIKEOUT_FACE A horizontal line is drawn through their middle.
- \c B_BOLD_FACE Characters are bold.
- \c B_REGULAR_FACE Characters are drawn normally.
Use condensed, not squished together. Better
2013-01-19 22:13:27 +04:00
- \c B_CONDENSED_FACE Characters are drawn condensed. Not in BeOS 5.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
- \c B_LIGHT_FACE Characters are drawn thiner than normal. Not in BeOS 5.
- \c B_HEAVY_FACE Characters are drawn heavier than normal. Not in BeOS 5.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\param face The bitmap of font face flags to set.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::SetFlags(uint32 flags)
\brief Sets font flags controlling antialiasing.
The following flags are supported:
Another minor fix, style constant
2013-01-19 11:54:22 +04:00
- \c B_DISABLE_ANTIALIASING Disable antialiasing.
- \c B_FORCE_ANTIALIASING Force antialiasing.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\param flags The bitmap of flags to set.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since Haiku R1
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\fn void BFont::GetFamilyAndStyle(font_family* family,
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
font_style *style) const
\brief Writes out the name of the font family and/or font style.
This method may be called with either \a family or \a style set to
\c NULL in order to get one or the other.
\param family A font_family pointer to be filled out.
\param style A font_style pointer to be filled out.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn uint32 BFont::FamilyAndStyle() const
\brief Gets the code of the font family and style combination.
\returns The family and style combination encoded as a unique integer.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetFamilyAndStyle(uint32 code)
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn float BFont::Size() const
\brief Gets the font size.
\returns The font size in points.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetSize()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\fn float BFont::Shear() const
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Gets the font shear.
\returns The font shear as an angle from 45.0° to 135.0°.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetShear()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn float BFont::Rotation() const
\brief Gets the font rotation.
\returns The font rotation as an angle in degrees.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetRotation()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn float BFont::FalseBoldWidth() const
\brief Gets the width of the font as if it were bold.
\returns The font width of the bold font variety.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetFalseBoldWidth()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since Haiku R1
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn uint8 BFont::Spacing() const
\brief Gets the spacing constant.
\returns The spacing constant.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetSpacing()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn uint8 BFont::Encoding() const
\brief Gets the character encoding constant.
\returns The character encoding constant.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetEncoding()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn uint16 BFont::Face() const
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Gets the font face flags bitmap.
\returns The font face flags bitmap.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetFace()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn uint32 BFont::Flags() const
\brief Gets the antialiasing flags.
\returns The antialiasing flags.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\see SetFlags()
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn font_direction BFont::Direction() const
\brief Gets the font direction, left-to-right or right-to left.
\returns The font direction.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn bool BFont::IsFixed() const
\brief Gets whether or not the font is fixed width.
\returns \c true if the font is fixed width, \c false otherwise.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
/*!
\fn bool BFont::IsFullAndHalfFixed() const
\brief Returns whether or not the font is fixed-width and contains both
full and half-width characters.
\note This was left unimplemented as of R5. It is a way to work with both
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
Kanji and Roman characters in the same fixed-width font.
\since BeOS R4
Add initial BFont documentation
2013-01-19 05:10:09 +04:00
*/
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
/*!
\fn BRect BFont::BoundingBox() const
\brief Gets a BRect that encloses the font text.
\returns A BRect that encloses the font text.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn unicode_block BFont::Blocks() const
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Gets a \c unicode_block object that identifies the Unicode blocks
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
supported by this font face and family.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\attention Currently unimplemented, returns an empty \a unicode_block
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
object.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\returns A \c unicode_block object containing supported Unicode blocks.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn font_file_format BFont::FileFormat() const
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\brief Gets whether the font is a TrueType™ or PostScript™ Type1 font.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\returns A \c font_file_format struct containing the font file format.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn int32 BFont::CountTuned() const
\brief Gets the number of tuned fonts for the font family and style.
\returns The number of tuned fonts.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetTunedInfo(int32 index, tuned_font_info *info) const
\brief Writes information about the tuned font at \a index into \a info.
The index begins at 0 and counts tuned fonts for current font family and
style only.
\param index The index of desired tuned font.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
\param info The \a turned_font_info struct to be filled out.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::TruncateString(BString *inOut, uint32 mode,
float width) const
\brief Truncates \a inOut to be no longer than \a width using the
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
supplied truncation \a mode.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
The following truncation modes are supported:
- \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_END Truncate from the end of the string.
- \c B_TRUNCATE_SMART Truncate from anywhere, but do so so that each
string is made unique after being truncated.
\param inOut The BString to truncate.
\param mode Truncation mode to use.
\param width The maximum width to truncate to.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R5
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetTruncatedStrings(const char *stringArray[],
int32 numStrings, uint32 mode, float width,
BString resultArray[]) const
\brief Write truncated BString objects to \a resultArray given source
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
BString objects in \a stringArray.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
The following truncation modes are supported:
- \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_END Truncate from the end of the string.
- \c B_TRUNCATE_SMART Truncate from anywhere, but do so so that each
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
string is made unique after being truncated.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param stringArray The source string array.
\param numStrings The number of strings in \a stringArray.
\param mode Truncation mode to use.
\param width The maximum width to truncate to.
\param resultArray The destination string array.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R5
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetTruncatedStrings(const char *stringArray[],
int32 numStrings, uint32 mode, float width, char *resultArray[]) const
\brief Write truncated strings to \a resultArray given source
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
BString objects in \a stringArray.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\a resultArray is an array of pointers to string buffers which should be
allocated ahead of time and should be at least 3 bytes longer than the
matching input string. The 3 extra bytes provide enough room for the
truncated output given that GetTruncatedStrings() truncates only a
single-byte character from the input string and replaces it with an
ellipsis character (which takes three bytes for the UTF-8 encoding),
and adds a \c NUL-terminator.
The following truncation modes are supported:
- \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_END Truncate from the end of the string.
- \c B_TRUNCATE_SMART Truncate from anywhere, but do so so that each
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
string is made unique after being truncated.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param stringArray The source string array.
\param numStrings The number of strings in \a stringArray.
\param mode Truncation mode to use.
\param width The maximum width to truncate to.
\param resultArray The destination string array.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R5
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn float BFont::StringWidth(const char *string) const
\brief Determines the amount of space required to draw \a string in the
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
current font.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param string The source string.
\returns The width required to draw the string.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn float BFont::StringWidth(const char *string, int32 length) const
\brief Determines the amount of space required to draw \a string in the
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
current font up to \a length characters.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param string The source string.
\param length The number of characters in \a string to consider.
\returns The width required to draw the string.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetStringWidths(const char *stringArray[],
const int32 lengthArray[], int32 numStrings, float widthArray[]) const
\brief Determines the amount of space required to draw each string in
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\a stringArray and writes the result in \a widthArray.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param stringArray The source string array.
\param lengthArray The number of characters to consider for each string in
\a stringArray
\param numStrings The number of strings in \a stringArray.
\param widthArray The destination array to put the widths required to draw
each string.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetEscapements(const char charArray[], int32 numChars,
float escapementArray[]) const
\brief Determines the escapements for each char in \a charArray and writes
the result in \a escapementArray.
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
\param escapementArray The destination array to put the escapements.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetEscapements(const char charArray[], int32 numChars,
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
escapement_delta* delta, float escapementArray[]) const
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Determines the escapements for each char in \a charArray and writes
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
the result in \a escapementArray with consideration to the horizontal
space provided by the escapement \a delta.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
The escapement_delta structure contains the following values:
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
- \c nonspace The amount of horizontal space to surround a visible glyph
character with.
- \c space The amount of horizontal space to surround a whitespace character
with, for example \c B_TAB or \c B_SPACE.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
\param delta The escapement_delta structure to use.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param escapementArray The destination array to put the escapements.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetEscapements(const char charArray[], int32 numChars,
escapement_delta *delta, BPoint escapementArray[]) const
\brief Determines the escapements for each char in \a charArray and writes
the result in \a escapementArray as an array of BPoint objects
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
with consideration to the horizontal space provided by the escapement
\a delta.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
The escapement_delta structure contains the following values:
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
- \c nonspace The amount of horizontal space to surround a visible glyph
character with.
- \c space The amount of horizontal space to surround a whitespace character
with, for example \c B_TAB or \c B_SPACE.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
\param delta The escapement_delta structure to use.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param escapementArray The destination array of escapements as BPoint
objects.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetEscapements(const char charArray[], int32 numChars,
escapement_delta *delta, BPoint escapementArray[],
BPoint offsetArray[]) const
\brief Determines the escapements for each char in \a charArray and writes
the result in \a escapementArray as an array of BPoint objects
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
with consideration to the horizontal space provided by the escapement
\a delta and writes the offsets to \a offsetArray.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
The escapement_delta structure contains the following values:
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
- \c nonspace The amount of horizontal space to surround a visible glyph
character with.
- \c space The amount of horizontal space to surround a whitespace character
with, for example \c B_TAB or \c B_SPACE.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
\param delta The escapement_delta structure to use.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param escapementArray The destination array of escapements as BPoint
objects.
\param offsetArray The destination array of offsets as BPoint objects.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetEdges(const char charArray[], int32 numChars,
edge_info edgeArray[]) const
\brief Determines the edge information for each character in \a charArray
and writes the result in \a edgeArray.
The \c edge_info struct contains the following values:
- \c left The distance that the character outline is inset from the left
escapement boundary.
- \c right The distance that the character outline is inset from the
right escapement boundary.
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
\param edgeArray The destination array of \c edge_info structs.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetHeight(font_height *_height) const
\brief Fills out the \c font_height struct with the amount of vertical
space surrounding a character.
The \c font_height struct contains the following values:
- \c ascent The distance characters can ascend above the baseline.
- \c descent The distance characters can descend below the baseline.
- \c leading The distance between lines, descent above to ascent below.
\param _height The \c font_height struct to fill out.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetBoundingBoxesAsGlyphs(const char charArray[],
int32 numChars, font_metric_mode mode, BRect boundingBoxArray[]) const
\brief Writes an array of BRect objects to \a boundingBoxArray
representing the bounding rectangles of each character in
\a charArray.
Each BRect object corresponds to the glyph of one character.
The \c font_metric_mode should contain one of the following values:
- \c B_SCREEN_METRIC The bounding boxes should use the screen metric.
- \c B_PRINTING_METRIC The bounding boxes should use the print metric.
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
\param mode The \c font_metric_mode to use, screen or printing.
\param boundingBoxArray The destination array of BRect bounding boxes.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetBoundingBoxesAsString(const char charArray[],
int32 numChars, font_metric_mode mode, escapement_delta *delta,
BRect boundingBoxArray[]) const
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
\brief Writes an array of BRect objects to \a boundingBoxArray representing
the bounding rectangles of each character in \a charArray with
consideration to the horizontal space provided by the escapement
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\a delta.
Each BRect object corresponds to the glyph of one character.
The \c font_metric_mode should contain one of the following values:
- \c B_SCREEN_METRIC The bounding boxes should use the screen metric.
- \c B_PRINTING_METRIC The bounding boxes should use the print metric.
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
The provided escapement \a delta is applied as part of the bounding box
calculations. This lets you specify a character spacing is looser or
tighter than normal.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
The escapement_delta structure contains the following values:
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
- \c nonspace The amount of horizontal space to surround a visible glyph
character with.
- \c space The amount of horizontal space to surround a whitespace character
with, for example \c B_TAB or \c B_SPACE.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
\param mode The \c font_metric_mode to use, screen or printing.
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
\param delta The escapement_delta structure to use.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param boundingBoxArray The destination array of BRect bounding boxes.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
\fn void BFont::GetBoundingBoxesForStrings(const char *stringArray[],
int32 numStrings, font_metric_mode mode, escapement_delta deltas[],
BRect boundingBoxArray[]) const
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
\brief Writes an array of BRect objects to \a boundingBoxArray representing
the bounding rectangles of each string in \a stringArray with
consideration to the horizontal space provided by the escapement
\a deltas.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
Each BRect object corresponds to the bounding box of the entire string.
The \c font_metric_mode should contain one of the following values:
- \c B_SCREEN_METRIC The bounding boxes should use the screen metric.
- \c B_PRINTING_METRIC The bounding boxes should use the print metric.
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
The provided escapement \a deltas are applied as part of the bounding box
calculations. This lets you specify a character spacing is looser or tighter
than normal.
Fill out BFont detailed description. Also a bunch of cleanup including removing private method docs and cleaning up language. BFont is pretty much completely documented at this point.
2013-01-19 11:45:18 +04:00
BFont docs: Clarify escapement_delta language. Make it clear that the values provided by the escapement_delta struct are an input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 22:24:40 +04:00
The escapement_delta structure contains the following values:
- \c nonspace The amount of horizontal space to surround a visible glyph
character with.
- \c space The amount of horizontal space to surround a whitespace character
with, for example \c B_TAB or \c B_SPACE.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param stringArray The source string array.
\param numStrings The number of strings to consider in \a stringArray.
\param mode The \c font_metric_mode to use, screen or printing.
By removing the style on escapement_delta doxygen links it up which is better
2013-01-19 12:01:55 +04:00
\param deltas The array of escapement_delta structures to use.
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\param boundingBoxArray The destination array of BRect bounding boxes.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
Add a few missing \fn's to BFont docs
2014-07-15 03:02:12 +04:00
\fn void BFont::GetGlyphShapes(const char charArray[], int32 numChars,
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
BShape *glyphShapeArray[]) const
\brief Writes an array of BShape objects to \a glyphShapeArray
representing the glyph shapes of each character in
\a charArray.
Each BShape object corresponds to the glyph of one character.
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
\param glyphShapeArray The destination array of BShape glyphs.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
Add a few missing \fn's to BFont docs
2014-07-15 03:02:12 +04:00
\fn void BFont::GetHasGlyphs(const char charArray[], int32 numChars,
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
bool hasArray[]) const
\brief Fills out \a hasArray with whether or not each characters in
\a charArray has a glyph for the font.
\c true is written in \a hasArray if the character has a glyph in the
current font and \c false is written in \a hasArray if the character
does NOT have a glyph in the current font.
\param charArray The source character array.
\param numChars The number of characters to consider in \a charArray.
\param hasArray The destination array of booleans.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R4
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
Add a few missing \fn's to BFont docs
2014-07-15 03:02:12 +04:00
\fn BFont& BFont::operator=(const BFont &font)
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Assignment overload method.
\param font The BFont object to assign from.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
Add a few missing \fn's to BFont docs
2014-07-15 03:02:12 +04:00
\fn bool BFont::operator==(const BFont &font) const
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Equality comparison overload method.
\param font The BFont object to compare the current font to.
\returns \c true if the fonts objects are identical, \c false otherwise.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
Add a few missing \fn's to BFont docs
2014-07-15 03:02:12 +04:00
\fn bool BFont::operator!=(const BFont &font) const
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Inequality comparison overload method.
\param font The BFont object to compare the current font to.
\returns \c true if the fonts objects are NOT identical, \c true
otherwise.
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
/*!
Add a few missing \fn's to BFont docs
2014-07-15 03:02:12 +04:00
\fn void BFont::PrintToStream() const
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
\brief Writes information about the font to \c stdout.
printf("BFont { %s (%d), %s (%d) 0x%x %f/%f %fpt (%f %f %f), %d }\n",
family, fFamilyID, style, fStyleID, fFace, fShear, fRotation, fSize,
fHeight.ascent, fHeight.descent, fHeight.leading, fEncoding);
IK documentation update * Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
2014-06-14 01:25:02 +04:00
\since BeOS R3
Fill out BFont member docs
2013-01-19 10:23:44 +04:00
*/
Reference in New Issue Copy Permalink