diff options
| author | egor-tensin <Egor.Tensin@gmail.com> | 2023-07-04 00:23:27 +0000 |
|---|---|---|
| committer | egor-tensin <Egor.Tensin@gmail.com> | 2023-07-04 00:23:27 +0000 |
| commit | f1ba68bd61d35f084bf42db123c6667e170b981d (patch) | |
| tree | c1f9f226f14a2da261b9b100241090c6a1310f83 /index.html | |
| download | winapi-utf8-f1ba68bd61d35f084bf42db123c6667e170b981d.tar.gz winapi-utf8-f1ba68bd61d35f084bf42db123c6667e170b981d.zip | |
Deploying to gh-pages from @ egor-tensin/winapi-utf8@5df6c58501383d82eff71e89e02957837258481c 🚀gh-pages
Diffstat (limited to 'index.html')
| -rw-r--r-- | index.html | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/index.html b/index.html new file mode 100644 index 0000000..41b4683 --- /dev/null +++ b/index.html @@ -0,0 +1,98 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>winapi_utf8: winapi-utf8</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="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.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">winapi_utf8 + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="PageDoc"><div class="header"> + <div class="headertitle"> +<div class="title">winapi-utf8 </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p><a class="anchor" id="md_README"></a></p> +<p><a href="https://github.com/egor-tensin/winapi-utf8/actions/workflows/ci.yml"><img src="https://github.com/egor-tensin/winapi-utf8/actions/workflows/ci.yml/badge.svg" alt="CI" style="pointer-events: none;" class="inline"/></a></p> +<p>UTF-8 <-> UTF-16 conversion functions, mainly to be used with WinAPI.</p> +<h1><a class="anchor" id="autotoc_md0"></a> +Usage</h1> +<p>Include it in your CMake project and link to the <code>winapi_utf8</code> target. Use the <code><a class="el" href="utf8_8hpp.html#ae643a038e8194c1f0d14bdf9edcafcb7">narrow()</a></code> and <code><a class="el" href="utf8_8hpp.html#a4b174d9e77015c16d3e3ab6ad95000b6">widen()</a></code> functions to convert to UTF-8 and UTF-16 respectively: </p><pre class="fragment">#include <winapi/utf8.hpp> + +winapi::narrow(u"Привет"); // Returns the UTF-8 representation +winapi::widen(u8"Привет"); // Returns the UTF-16 representation +</pre><p> See the various convenience overloads of these function in the <a href="https://egor-tensin.github.io/winapi-utf8/utf8_8hpp.html">online documentation</a>.</p> +<h1><a class="anchor" id="autotoc_md1"></a> +Development</h1> +<p>Build using CMake. Depends on Boost.Test. The project is Windows-only, so building with either MSVC or MinGW-w64 is required.</p> +<p>There's a Makefile with useful shortcuts to build the project in the build/ directory (defaults to building with MinGW-w64): </p><pre class="fragment">make deps +make build +make test +</pre> <h1><a class="anchor" id="autotoc_md2"></a> +Documentation</h1> +<p>Build & display the documentation using </p><pre class="fragment">make docs +</pre><p> View the online documentation at <a href="https://egor-tensin.github.io/winapi-utf8/">https://egor-tensin.github.io/winapi-utf8/</a>.</p> +<h1><a class="anchor" id="autotoc_md3"></a> +License</h1> +<p>Distributed under the MIT License. See <a href="LICENSE.txt">LICENSE.txt</a> for details. </p> +</div></div><!-- PageDoc --> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 +</small></address> +</body> +</html> |