// © 2016 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html /******************************************************************** * COPYRIGHT: * Copyright (c) 1997-2012, International Business Machines Corporation and * others. All Rights Reserved. * * FILE NAME: DOCMAIN.h * * Date Name Description * 12/11/2000 Ram Creation. */ /** * \file * \brief (Non API- contains Doxygen definitions) * * This file contains documentation for Doxygen and does not have * any significance with respect to C or C++ API */ /*! \mainpage * * \section API API Reference Usage * * <h3>C++ Programmers:</h3> * <p>Use <a href="hierarchy.html">Class Hierarchy</a> or <a href="classes.html"> Alphabetical List </a> * or <a href="annotated.html"> Compound List</a> * to find the class you are interested in. For example, to find BreakIterator, * you can go to the <a href="classes.html"> Alphabetical List</a>, then click on * "BreakIterator". Once you are at the class, you will find an inheritance * chart, a list of the public members, a detailed description of the class, * then detailed member descriptions.</p> * * <h3>C Programmers:</h3> * <p>Use <a href="#Module">Module List</a> or <a href="globals_u.html">File Members</a> * to find a list of all the functions and constants. * For example, to find BreakIterator functions you would click on * <a href="files.html"> File List</a>, * then find "ubrk.h" and click on it. You will find descriptions of Defines, * Typedefs, Enumerations, and Functions, with detailed descriptions below. * If you want to find a specific function, such as ubrk_next(), then click * first on <a href="globals.html"> File Members</a>, then use your browser * Find dialog to search for "ubrk_next()".</p> * * * <h3>API References for Previous Releases</h3> * <p>The API References for each release of ICU are also available as * a zip file from the ICU * <a href="https://icu.unicode.org/download">download page</a>.</p> * * <hr> * * <h2>Architecture (User's Guide)</h2> * <ul> * <li><a href="https://unicode-org.github.io/icu/userguide/">Introduction</a></li> * <li><a href="https://unicode-org.github.io/icu/userguide/i18n">Internationalization</a></li> * <li><a href="https://unicode-org.github.io/icu/userguide/design">Locale Model, Multithreading, Error Handling, etc.</a></li> * <li><a href="https://unicode-org.github.io/icu/userguide/conversion">Conversion</a></li> * </ul> * * <hr> *\htmlonly <h2><a NAME="Module">Module List</a></h2> \endhtmlonly * <table border="1" cols="3" align="center"> * <tr> * <td><strong>Module Name</strong></td> * <td><strong>C</strong></td> * <td><strong>C++</strong></td> * </tr> * <tr> * <td>Basic Types and Constants</td> * <td>utypes.h</td> * <td>utypes.h</td> * </tr> * <tr> * <td>Strings and Character Iteration</td> * <td>ustring.h, utf8.h, utf16.h, icu::StringPiece, UText, UCharIterator, icu::ByteSink</td> * <td>icu::UnicodeString, icu::CharacterIterator, icu::Appendable, icu::StringPiece,icu::ByteSink</td> * </tr> * <tr> * <td>Unicode Character<br/>Properties and Names</td> * <td>uchar.h, uscript.h</td> * <td>C API</td> * </tr> * <tr> * <td>Sets of Unicode Code Points and Strings</td> * <td>uset.h</td> * <td>icu::UnicodeSet</td> * </tr> * <tr> * <td>Maps from Unicode Code Points to Integer Values</td> * <td>ucptrie.h, umutablecptrie.h</td> * <td>C API</td> * </tr> * <tr> * <td>Maps from Strings to Integer Values</td> * <td>(no C API)</td> * <td>icu::BytesTrie, icu::UCharsTrie</td> * </tr> * <tr> * <td>Codepage Conversion</td> * <td>ucnv.h, ucnvsel.h</td> * <td>C API</td> * </tr> * <tr> * <td>Codepage Detection</td> * <td>ucsdet.h</td> * <td>C API</td> * </tr> * <tr> * <td>Unicode Text Compression</td> * <td>ucnv.h<br/>(encoding name "SCSU" or "BOCU-1")</td> * <td>C API</td> * </tr> * <tr> * <td>Locales </td> * <td>uloc.h</a></td> * <td>icu::Locale, icu::LocaleBuilder, icu::LocaleMatcher</td> * </tr> * <tr> * <td>Resource Bundles</td> * <td>ures.h</td> * <td>icu::ResourceBundle</td> * </tr> * <tr> * <td>Normalization</td> * <td>unorm2.h</td> * <td>icu::Normalizer2</td> * </tr> * <tr> * <td>Calendars and Time Zones</td> * <td>ucal.h</td> * <td>icu::Calendar, icu::TimeZone</td> * </tr> * <tr> * <td>Date and Time Formatting</td> * <td>udat.h</td> * <td>icu::DateFormat</td> * </tr> * <tr> * <td>Message Formatting</td> * <td>umsg.h</td> * <td>icu::MessageFormat</td> * </tr> * <tr> * <td>List Formatting</td> * <td>ulistformatter.h</td> * <td>icu::ListFormatter</td> * </tr> * <tr> * <td>Number Formatting<br/>(includes currency and unit formatting)</td> * <td>unumberformatter.h, unum.h</td> * <td>icu::number::NumberFormatter (ICU 60+) or icu::NumberFormat (older versions)</td> * </tr> * <tr> * <td>Number Range Formatting<br />(includes currency and unit ranges)</td> * <td>unumberrangeformatter.h</td> * <td>icu::number::NumberRangeFormatter</td> * </tr> * <tr> * <td>Number Spellout<br/>(Rule Based Number Formatting)</td> * <td>unum.h<br/>(use UNUM_SPELLOUT)</td> * <td>icu::RuleBasedNumberFormat</td> * </tr> * <tr> * <td>Text Transformation<br/>(Transliteration)</td> * <td>utrans.h</td> * <td>icu::Transliterator</td> * </tr> * <tr> * <td>Bidirectional Algorithm</td> * <td>ubidi.h, ubiditransform.h</td> * <td>C API</td> * </tr> * <tr> * <td>Arabic Shaping</td> * <td>ushape.h</td> * <td>C API</td> * </tr> * <tr> * <td>Collation</td> * <td>ucol.h</td> * <td>icu::Collator</td> * </tr> * <tr> * <td>String Searching</td> * <td>usearch.h</td> * <td>icu::StringSearch</td> * </tr> * <tr> * <td>Index Characters/<br/>Bucketing for Sorted Lists</td> * <td>(no C API)</td> * <td>icu::AlphabeticIndex</td> * </tr> * <tr> * <td>Text Boundary Analysis<br/>(Break Iteration)</td> * <td>ubrk.h</td> * <td>icu::BreakIterator</td> * </tr> * <tr> * <td>Regular Expressions</td> * <td>uregex.h</td> * <td>icu::RegexPattern, icu::RegexMatcher</td> * </tr> * <tr> * <td>StringPrep</td> * <td>usprep.h</td> * <td>C API</td> * </tr> * <tr> * <td>International Domain Names in Applications:<br/> * UTS #46 in C/C++, IDNA2003 only via C API</td> * <td>uidna.h</td> * <td>idna.h</td> * </tr> * <tr> * <td>Identifier Spoofing & Confusability</td> * <td>uspoof.h</td> * <td>C API</td> * <tr> * <td>Universal Time Scale</td> * <td>utmscale.h</td> * <td>C API</td> * </tr> * <tr> * <td>Paragraph Layout / Complex Text Layout</td> * <td>playout.h</td> * <td>icu::ParagraphLayout</td> * </tr> * <tr> * <td>ICU I/O</td> * <td>ustdio.h</td> * <td>ustream.h</td> * </tr> * </table> * <i>This main page is generated from docmain.h</i> */
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
alphaindex.h | File | 26.53 KB | 0644 |
|
appendable.h | File | 8.53 KB | 0644 |
|
basictz.h | File | 9.98 KB | 0644 |
|
brkiter.h | File | 27.81 KB | 0644 |
|
bytestream.h | File | 10.75 KB | 0644 |
|
bytestrie.h | File | 20.78 KB | 0644 |
|
bytestriebuilder.h | File | 7.48 KB | 0644 |
|
calendar.h | File | 102.25 KB | 0644 |
|
caniter.h | File | 7.47 KB | 0644 |
|
casemap.h | File | 25.33 KB | 0644 |
|
char16ptr.h | File | 7.22 KB | 0644 |
|
chariter.h | File | 24.06 KB | 0644 |
|
choicfmt.h | File | 23.98 KB | 0644 |
|
coleitr.h | File | 13.78 KB | 0644 |
|
coll.h | File | 56.27 KB | 0644 |
|
compactdecimalformat.h | File | 6.88 KB | 0644 |
|
curramt.h | File | 3.78 KB | 0644 |
|
currpinf.h | File | 7.3 KB | 0644 |
|
currunit.h | File | 4.02 KB | 0644 |
|
datefmt.h | File | 40.71 KB | 0644 |
|
dbbi.h | File | 1.19 KB | 0644 |
|
dcfmtsym.h | File | 20.61 KB | 0644 |
|
decimfmt.h | File | 87.57 KB | 0644 |
|
displayoptions.h | File | 7.11 KB | 0644 |
|
docmain.h | File | 7.21 KB | 0644 |
|
dtfmtsym.h | File | 38.22 KB | 0644 |
|
dtintrv.h | File | 3.85 KB | 0644 |
|
dtitvfmt.h | File | 49.27 KB | 0644 |
|
dtitvinf.h | File | 18.63 KB | 0644 |
|
dtptngen.h | File | 28.69 KB | 0644 |
|
dtrule.h | File | 8.69 KB | 0644 |
|
edits.h | File | 20.74 KB | 0644 |
|
enumset.h | File | 2.08 KB | 0644 |
|
errorcode.h | File | 4.84 KB | 0644 |
|
fieldpos.h | File | 8.7 KB | 0644 |
|
filteredbrk.h | File | 5.37 KB | 0644 |
|
fmtable.h | File | 24.43 KB | 0644 |
|
format.h | File | 12.5 KB | 0644 |
|
formattedvalue.h | File | 9.75 KB | 0644 |
|
fpositer.h | File | 3.03 KB | 0644 |
|
gender.h | File | 3.35 KB | 0644 |
|
gregocal.h | File | 31.04 KB | 0644 |
|
icudataver.h | File | 1.02 KB | 0644 |
|
icuplug.h | File | 11.83 KB | 0644 |
|
idna.h | File | 12.71 KB | 0644 |
|
listformatter.h | File | 8.61 KB | 0644 |
|
localebuilder.h | File | 11.08 KB | 0644 |
|
localematcher.h | File | 26.84 KB | 0644 |
|
localpointer.h | File | 19.36 KB | 0644 |
|
locdspnm.h | File | 7.12 KB | 0644 |
|
locid.h | File | 47.66 KB | 0644 |
|
measfmt.h | File | 11.42 KB | 0644 |
|
measunit.h | File | 106.33 KB | 0644 |
|
measure.h | File | 4.33 KB | 0644 |
|
messagepattern.h | File | 33.71 KB | 0644 |
|
msgfmt.h | File | 44.17 KB | 0644 |
|
normalizer2.h | File | 33.66 KB | 0644 |
|
normlzr.h | File | 30.96 KB | 0644 |
|
nounit.h | File | 2.25 KB | 0644 |
|
numberformatter.h | File | 94.82 KB | 0644 |
|
numberrangeformatter.h | File | 25.02 KB | 0644 |
|
numfmt.h | File | 49.84 KB | 0644 |
|
numsys.h | File | 7.22 KB | 0644 |
|
parseerr.h | File | 3.08 KB | 0644 |
|
parsepos.h | File | 5.57 KB | 0644 |
|
platform.h | File | 28.55 KB | 0644 |
|
plurfmt.h | File | 25.25 KB | 0644 |
|
plurrule.h | File | 20.62 KB | 0644 |
|
ptypes.h | File | 3.49 KB | 0644 |
|
putil.h | File | 6.32 KB | 0644 |
|
rbbi.h | File | 28.46 KB | 0644 |
|
rbnf.h | File | 49.82 KB | 0644 |
|
rbtz.h | File | 15.77 KB | 0644 |
|
regex.h | File | 84.41 KB | 0644 |
|
region.h | File | 9.18 KB | 0644 |
|
reldatefmt.h | File | 22.22 KB | 0644 |
|
rep.h | File | 9.37 KB | 0644 |
|
resbund.h | File | 18.09 KB | 0644 |
|
schriter.h | File | 6.1 KB | 0644 |
|
scientificnumberformatter.h | File | 6.44 KB | 0644 |
|
search.h | File | 22.22 KB | 0644 |
|
selfmt.h | File | 14.35 KB | 0644 |
|
simpleformatter.h | File | 12.59 KB | 0644 |
|
simpletz.h | File | 45.65 KB | 0644 |
|
smpdtfmt.h | File | 71.93 KB | 0644 |
|
sortkey.h | File | 11.18 KB | 0644 |
|
std_string.h | File | 1.05 KB | 0644 |
|
strenum.h | File | 9.92 KB | 0644 |
|
stringoptions.h | File | 5.79 KB | 0644 |
|
stringpiece.h | File | 10.05 KB | 0644 |
|
stringtriebuilder.h | File | 15.47 KB | 0644 |
|
stsearch.h | File | 21.42 KB | 0644 |
|
symtable.h | File | 4.27 KB | 0644 |
|
tblcoll.h | File | 36.92 KB | 0644 |
|
timezone.h | File | 43.81 KB | 0644 |
|
tmunit.h | File | 3.4 KB | 0644 |
|
tmutamt.h | File | 4.91 KB | 0644 |
|
tmutfmt.h | File | 7.42 KB | 0644 |
|
translit.h | File | 65.82 KB | 0644 |
|
tzfmt.h | File | 42.93 KB | 0644 |
|
tznames.h | File | 16.85 KB | 0644 |
|
tzrule.h | File | 34.86 KB | 0644 |
|
tztrans.h | File | 6.13 KB | 0644 |
|
ubidi.h | File | 89.61 KB | 0644 |
|
ubiditransform.h | File | 12.71 KB | 0644 |
|
ubrk.h | File | 24.43 KB | 0644 |
|
ucal.h | File | 60.68 KB | 0644 |
|
ucasemap.h | File | 15.21 KB | 0644 |
|
ucat.h | File | 5.35 KB | 0644 |
|
uchar.h | File | 145.09 KB | 0644 |
|
ucharstrie.h | File | 22.53 KB | 0644 |
|
ucharstriebuilder.h | File | 7.48 KB | 0644 |
|
uchriter.h | File | 13.42 KB | 0644 |
|
uclean.h | File | 11.2 KB | 0644 |
|
ucnv.h | File | 83.46 KB | 0644 |
|
ucnv_cb.h | File | 6.58 KB | 0644 |
|
ucnv_err.h | File | 20.98 KB | 0644 |
|
ucnvsel.h | File | 6.24 KB | 0644 |
|
ucol.h | File | 61.95 KB | 0644 |
|
ucoleitr.h | File | 9.82 KB | 0644 |
|
uconfig.h | File | 12.07 KB | 0644 |
|
ucpmap.h | File | 5.54 KB | 0644 |
|
ucptrie.h | File | 22.51 KB | 0644 |
|
ucsdet.h | File | 14.69 KB | 0644 |
|
ucurr.h | File | 16.72 KB | 0644 |
|
udat.h | File | 62.36 KB | 0644 |
|
udata.h | File | 15.63 KB | 0644 |
|
udateintervalformat.h | File | 11.93 KB | 0644 |
|
udatpg.h | File | 30.18 KB | 0644 |
|
udisplaycontext.h | File | 5.94 KB | 0644 |
|
udisplayoptions.h | File | 8.8 KB | 0644 |
|
uenum.h | File | 7.79 KB | 0644 |
|
ufieldpositer.h | File | 4.41 KB | 0644 |
|
uformattable.h | File | 10.97 KB | 0644 |
|
uformattedvalue.h | File | 12.25 KB | 0644 |
|
ugender.h | File | 2.06 KB | 0644 |
|
uidna.h | File | 33.43 KB | 0644 |
|
uiter.h | File | 22.75 KB | 0644 |
|
uldnames.h | File | 10.48 KB | 0644 |
|
ulistformatter.h | File | 10.78 KB | 0644 |
|
uloc.h | File | 54.66 KB | 0644 |
|
ulocdata.h | File | 11.3 KB | 0644 |
|
umachine.h | File | 15.73 KB | 0644 |
|
umisc.h | File | 1.34 KB | 0644 |
|
umsg.h | File | 24.25 KB | 0644 |
|
umutablecptrie.h | File | 8.3 KB | 0644 |
|
unifilt.h | File | 4 KB | 0644 |
|
unifunct.h | File | 4.05 KB | 0644 |
|
unimatch.h | File | 6.1 KB | 0644 |
|
unirepl.h | File | 3.38 KB | 0644 |
|
uniset.h | File | 66.12 KB | 0644 |
|
unistr.h | File | 170.53 KB | 0644 |
|
unorm.h | File | 20.55 KB | 0644 |
|
unorm2.h | File | 24.68 KB | 0644 |
|
unum.h | File | 56.6 KB | 0644 |
|
unumberformatter.h | File | 30.26 KB | 0644 |
|
unumberrangeformatter.h | File | 15.35 KB | 0644 |
|
unumsys.h | File | 7.26 KB | 0644 |
|
uobject.h | File | 10.68 KB | 0644 |
|
upluralrules.h | File | 8.79 KB | 0644 |
|
uregex.h | File | 71.99 KB | 0644 |
|
uregion.h | File | 9.81 KB | 0644 |
|
ureldatefmt.h | File | 17.04 KB | 0644 |
|
urename.h | File | 135.69 KB | 0644 |
|
urep.h | File | 5.38 KB | 0644 |
|
ures.h | File | 36.54 KB | 0644 |
|
uscript.h | File | 27.8 KB | 0644 |
|
usearch.h | File | 39.21 KB | 0644 |
|
uset.h | File | 44.19 KB | 0644 |
|
usetiter.h | File | 9.63 KB | 0644 |
|
ushape.h | File | 18 KB | 0644 |
|
uspoof.h | File | 65.84 KB | 0644 |
|
usprep.h | File | 8.19 KB | 0644 |
|
ustdio.h | File | 38.56 KB | 0644 |
|
ustream.h | File | 1.89 KB | 0644 |
|
ustring.h | File | 72.36 KB | 0644 |
|
ustringtrie.h | File | 3.15 KB | 0644 |
|
utext.h | File | 58.08 KB | 0644 |
|
utf.h | File | 7.87 KB | 0644 |
|
utf16.h | File | 23.35 KB | 0644 |
|
utf32.h | File | 763 B | 0644 |
|
utf8.h | File | 30.83 KB | 0644 |
|
utf_old.h | File | 45.8 KB | 0644 |
|
utmscale.h | File | 13.78 KB | 0644 |
|
utrace.h | File | 17.18 KB | 0644 |
|
utrans.h | File | 25.54 KB | 0644 |
|
utypes.h | File | 31.06 KB | 0644 |
|
uvernum.h | File | 6.33 KB | 0644 |
|
uversion.h | File | 5.99 KB | 0644 |
|
vtzone.h | File | 20.68 KB | 0644 |
|