<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>ICU 58.2: udisplaycontext.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> </div> <div class="headertitle"> <div class="title">udisplaycontext.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>C API: Display context types (enum values) <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br /> </div> <p><a href="udisplaycontext_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a8f2f493e2353ff5999eafdf13c85a44e"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">UDisplayContextType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="udisplaycontext_8h.html#a8f2f493e2353ff5999eafdf13c85a44e">UDisplayContextType</a></td></tr> <tr class="separator:a8f2f493e2353ff5999eafdf13c85a44e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5593d5cf62e4305c2d827796d12ebfa8"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="udisplaycontext_8h.html#a5593d5cf62e4305c2d827796d12ebfa8">UDisplayContext</a></td></tr> <tr class="separator:a5593d5cf62e4305c2d827796d12ebfa8"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:a7ce674e7cd26fb195f7344b861af5427"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">UDisplayContextType</a> { <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427aa2b58b58d5734f9c0f21252d55c9a5cf">UDISPCTX_TYPE_DIALECT_HANDLING</a> = 0, <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427a37c10ed9a4407d082fa539d7205f610d">UDISPCTX_TYPE_CAPITALIZATION</a> = 1, <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427a2f437f10f28a404a1b12ad3a31cba68f">UDISPCTX_TYPE_DISPLAY_LENGTH</a> = 2, <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427a07b44ecb46a0110717ed24774f854a8a">UDISPCTX_TYPE_SUBSTITUTE_HANDLING</a> = 3 }<tr class="memdesc:a7ce674e7cd26fb195f7344b861af5427"><td class="mdescLeft"> </td><td class="mdescRight">Display context types, for getting values of a particular setting. <a href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">More...</a><br /></td></tr> </td></tr> <tr class="separator:a7ce674e7cd26fb195f7344b861af5427"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac80aa1aceff6c7ad2e9f983a19d8d868"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a> { <br />   <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868a993be53f009fc9888392de28a4dd489b">UDISPCTX_STANDARD_NAMES</a> = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 0, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868ab088db830f0fea15328ef96a78da78b3">UDISPCTX_DIALECT_NAMES</a> = (UDISPCTX_TYPE_DIALECT_HANDLING<<8) + 1, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868a9008345eb25953e1aa2508ec8282a8da">UDISPCTX_CAPITALIZATION_NONE</a> = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 0, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868afd59f54f553b91e983ae6d7e53c2a88a">UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE</a> = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 1, <br />   <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868ad916eb8c8e0dbfab6b01114678050c0e">UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE</a> = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 2, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868a856f8899ad56c07647261b411c6846c6">UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU</a> = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 3, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868ae57e3827c8f4b1be797e6bb0e7865962">UDISPCTX_CAPITALIZATION_FOR_STANDALONE</a> = (UDISPCTX_TYPE_CAPITALIZATION<<8) + 4, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868aa830a8a9f5a39ea1238b781b9db96089">UDISPCTX_LENGTH_FULL</a> = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 0, <br />   <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868a5da0329c42ea2e0afb0614352f326f28">UDISPCTX_LENGTH_SHORT</a> = (UDISPCTX_TYPE_DISPLAY_LENGTH<<8) + 1, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868abe84b713d2d396ae68477b3885ca5a55">UDISPCTX_SUBSTITUTE</a> = (UDISPCTX_TYPE_SUBSTITUTE_HANDLING<<8) + 0, <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868a0a0e5da13f64018a85b882bc5dc8e9b9">UDISPCTX_NO_SUBSTITUTE</a> = (UDISPCTX_TYPE_SUBSTITUTE_HANDLING<<8) + 1 <br /> }<tr class="memdesc:ac80aa1aceff6c7ad2e9f983a19d8d868"><td class="mdescLeft"> </td><td class="mdescRight">Display context settings. <a href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">More...</a><br /></td></tr> </td></tr> <tr class="separator:ac80aa1aceff6c7ad2e9f983a19d8d868"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>C API: Display context types (enum values) </p> <p>Definition in file <a class="el" href="udisplaycontext_8h_source.html">udisplaycontext.h</a>.</p> </div><h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="a5593d5cf62e4305c2d827796d12ebfa8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef enum <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a> <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a></td> </tr> </table> </div><div class="memdoc"> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001709">Stable:</a></b></dt><dd>ICU 51 </dd></dl> <p>Definition at line <a class="el" href="udisplaycontext_8h_source.html#l00172">172</a> of file <a class="el" href="udisplaycontext_8h_source.html">udisplaycontext.h</a>.</p> </div> </div> <a class="anchor" id="a8f2f493e2353ff5999eafdf13c85a44e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef enum <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">UDisplayContextType</a> <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">UDisplayContextType</a></td> </tr> </table> </div><div class="memdoc"> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001707">Stable:</a></b></dt><dd>ICU 51 </dd></dl> <p>Definition at line <a class="el" href="udisplaycontext_8h_source.html#l00059">59</a> of file <a class="el" href="udisplaycontext_8h_source.html">udisplaycontext.h</a>.</p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="udisplaycontext_8h.html#ac80aa1aceff6c7ad2e9f983a19d8d868">UDisplayContext</a></td> </tr> </table> </div><div class="memdoc"> <p>Display context settings. </p> <p>Note, the specific numeric values are internal and may change. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001708">Stable:</a></b></dt><dd>ICU 51 </dd></dl> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868a993be53f009fc9888392de28a4dd489b"></a>UDISPCTX_STANDARD_NAMES </td><td class="fielddoc"> <hr/> <p> DIALECT_HANDLING can be set to one of UDISPCTX_STANDARD_NAMES or UDISPCTX_DIALECT_NAMES. </p> <p>Use UDisplayContextType UDISPCTX_TYPE_DIALECT_HANDLING to get the value. A possible setting for DIALECT_HANDLING: use standard names when generating a locale name, e.g. en_GB displays as 'English (United Kingdom)'. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001713">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868ab088db830f0fea15328ef96a78da78b3"></a>UDISPCTX_DIALECT_NAMES </td><td class="fielddoc"> <p>A possible setting for DIALECT_HANDLING: use dialect names, when generating a locale name, e.g. </p> <p>en_GB displays as 'British English'. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001714">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868a9008345eb25953e1aa2508ec8282a8da"></a>UDISPCTX_CAPITALIZATION_NONE </td><td class="fielddoc"> <hr/> <p> CAPITALIZATION can be set to one of UDISPCTX_CAPITALIZATION_NONE, UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE, UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU, or UDISPCTX_CAPITALIZATION_FOR_STANDALONE. </p> <p>Use UDisplayContextType UDISPCTX_TYPE_CAPITALIZATION to get the value. The capitalization context to be used is unknown (this is the default value). </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001715">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868afd59f54f553b91e983ae6d7e53c2a88a"></a>UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE </td><td class="fielddoc"> <p>The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the middle of a sentence. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001716">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868ad916eb8c8e0dbfab6b01114678050c0e"></a>UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE </td><td class="fielddoc"> <p>The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the beginning of a sentence. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001717">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868a856f8899ad56c07647261b411c6846c6"></a>UDISPCTX_CAPITALIZATION_FOR_UI_LIST_OR_MENU </td><td class="fielddoc"> <p>The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for a user-interface list or menu item. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001718">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868ae57e3827c8f4b1be797e6bb0e7865962"></a>UDISPCTX_CAPITALIZATION_FOR_STANDALONE </td><td class="fielddoc"> <p>The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for stand-alone usage such as an isolated name on a calendar page. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001719">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868aa830a8a9f5a39ea1238b781b9db96089"></a>UDISPCTX_LENGTH_FULL </td><td class="fielddoc"> <hr/> <p> DISPLAY_LENGTH can be set to one of UDISPCTX_LENGTH_FULL or UDISPCTX_LENGTH_SHORT. </p> <p>Use UDisplayContextType UDISPCTX_TYPE_DISPLAY_LENGTH to get the value. A possible setting for DISPLAY_LENGTH: use full names when generating a locale name, e.g. "United States" for US. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001720">Stable:</a></b></dt><dd>ICU 54 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868a5da0329c42ea2e0afb0614352f326f28"></a>UDISPCTX_LENGTH_SHORT </td><td class="fielddoc"> <p>A possible setting for DISPLAY_LENGTH: use short names when generating a locale name, e.g. </p> <p>"U.S." for US. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001721">Stable:</a></b></dt><dd>ICU 54 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868abe84b713d2d396ae68477b3885ca5a55"></a>UDISPCTX_SUBSTITUTE </td><td class="fielddoc"> <hr/> <p> SUBSTITUTE_HANDLING can be set to one of UDISPCTX_SUBSTITUTE or UDISPCTX_NO_SUBSTITUTE. </p> <p>Use UDisplayContextType UDISPCTX_TYPE_SUBSTITUTE_HANDLING to get the value. A possible setting for SUBSTITUTE_HANDLING: Returns a fallback value (e.g., the input code) when no data is available. This is the default value. </p><dl class="draft"><dt><b><a class="el" href="draft.html#_draft000035">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 58 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="ac80aa1aceff6c7ad2e9f983a19d8d868a0a0e5da13f64018a85b882bc5dc8e9b9"></a>UDISPCTX_NO_SUBSTITUTE </td><td class="fielddoc"> <p>A possible setting for SUBSTITUTE_HANDLING: Returns a null value when no data is available. </p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000036">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 58 </dd></dl> </td></tr> </table> <p>Definition at line <a class="el" href="udisplaycontext_8h_source.html#l00066">66</a> of file <a class="el" href="udisplaycontext_8h_source.html">udisplaycontext.h</a>.</p> </div> </div> <a class="anchor" id="a7ce674e7cd26fb195f7344b861af5427"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="udisplaycontext_8h.html#a7ce674e7cd26fb195f7344b861af5427">UDisplayContextType</a></td> </tr> </table> </div><div class="memdoc"> <p>Display context types, for getting values of a particular setting. </p> <p>Note, the specific numeric values are internal and may change. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001706">Stable:</a></b></dt><dd>ICU 51 </dd></dl> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a7ce674e7cd26fb195f7344b861af5427aa2b58b58d5734f9c0f21252d55c9a5cf"></a>UDISPCTX_TYPE_DIALECT_HANDLING </td><td class="fielddoc"> <p>Type to retrieve the dialect handling setting, e.g. </p> <p>UDISPCTX_STANDARD_NAMES or UDISPCTX_DIALECT_NAMES. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001710">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a7ce674e7cd26fb195f7344b861af5427a37c10ed9a4407d082fa539d7205f610d"></a>UDISPCTX_TYPE_CAPITALIZATION </td><td class="fielddoc"> <p>Type to retrieve the capitalization context setting, e.g. </p> <p>UDISPCTX_CAPITALIZATION_NONE, UDISPCTX_CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE, UDISPCTX_CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE, etc. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001711">Stable:</a></b></dt><dd>ICU 51 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a7ce674e7cd26fb195f7344b861af5427a2f437f10f28a404a1b12ad3a31cba68f"></a>UDISPCTX_TYPE_DISPLAY_LENGTH </td><td class="fielddoc"> <p>Type to retrieve the display length setting, e.g. </p> <p>UDISPCTX_LENGTH_FULL, UDISPCTX_LENGTH_SHORT. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001712">Stable:</a></b></dt><dd>ICU 54 </dd></dl> </td></tr> <tr><td class="fieldname"><a class="anchor" id="a7ce674e7cd26fb195f7344b861af5427a07b44ecb46a0110717ed24774f854a8a"></a>UDISPCTX_TYPE_SUBSTITUTE_HANDLING </td><td class="fielddoc"> <p>Type to retrieve the substitute handling setting, e.g. </p> <p>UDISPCTX_SUBSTITUTE, UDISPCTX_NO_SUBSTITUTE. </p><dl class="draft"><dt><b><a class="el" href="draft.html#_draft000034">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 58 </dd></dl> </td></tr> </table> <p>Definition at line <a class="el" href="udisplaycontext_8h_source.html#l00027">27</a> of file <a class="el" href="udisplaycontext_8h_source.html">udisplaycontext.h</a>.</p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>