summaryrefslogtreecommitdiff
path: root/FL/fl_utf8.h
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2009-04-15 08:35:28 +0000
committerMatthias Melcher <fltk@matthiasm.com>2009-04-15 08:35:28 +0000
commitd3206f01ec18e61e8cd9c7e88b02a6313ab227fa (patch)
treeada81f236fbf8b967f5de8d45b39ad23cbd75d7f /FL/fl_utf8.h
parentb214cef3a8d2d9ecf0df7bef7d10dcdfbca4d9d3 (diff)
More Fl_Input keyboard fixes / OS X transparency for RGBA data / some utf8 reorganisation
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6765 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/fl_utf8.h')
-rw-r--r--FL/fl_utf8.h18
1 files changed, 17 insertions, 1 deletions
diff --git a/FL/fl_utf8.h b/FL/fl_utf8.h
index f365de5be..9db53d3ff 100644
--- a/FL/fl_utf8.h
+++ b/FL/fl_utf8.h
@@ -30,6 +30,11 @@
/*** NOTE : all functions are LIMITED to 24 bits Unicode values !!! ***/
+/**
+ \file fl_utf8.h
+ \brief header for Unicode and UTF8 chracter handling
+*/
+
#ifndef _HAVE_FL_UTF8_HDR_
#define _HAVE_FL_UTF8_HDR_
@@ -78,12 +83,20 @@
extern "C" {
# endif
+/** \addtogroup fl_unicode
+ @{
+*/
+
int fl_unichar_to_utf8_size(Fl_Unichar);
/* F2: comes from FLTK2 */
/* OD: comes from OksiD */
-/* F2: How many bytes will be used to encode this wide character as UTF8? */
+/**
+ Return the number of bytes needed to encode the given UCS4 character in UTF8.
+ \param [in] ucs UCS4 encoded character
+ \return number of bytes required
+ */
FL_EXPORT int fl_utf8bytes(unsigned ucs);
/* OD: returns the byte length of the first UTF-8 char sequence (returns -1 if not valid) */
@@ -222,6 +235,9 @@ FL_EXPORT void fl_make_path_for_file( const char *path );
/* OD: recursively create a path in the file system */
FL_EXPORT char fl_make_path( const char *path );
+
+/** @} */
+
/*****************************************************************************/
#ifdef __cplusplus