Xutf8LookupString(3)
NAME
XmbLookupString, XwcLookupString, Xutf8LookupString - obtain composed input from an input method
SYNTAX
int XmbLookupString(XIC ic, XKeyPressedEvent *event, char
*buffer_return, int bytes_buffer, KeySym *keysym_return, Status
*status_return);
int XwcLookupString(XIC ic, XKeyPressedEvent *event, wchar_t
*buffer_return, int wchars_buffer, KeySym *keysym_return, Status
*status_return);
int Xutf8LookupString(XIC ic, XKeyPressedEvent *event, char
*buffer_return, int bytes_buffer, KeySym *keysym_return, Status
*status_return);
ARGUMENTS
buffer_return
Returns a multibyte string or wide character string (if any)
from the input method.
bytes_buffer
wchars_buffer
Specifies space available in the return buffer.
event Specifies the key event to be used.
ic Specifies the input context.
keysym_return
Returns the KeySym computed from the event if this argument
is not NULL.
status_return
Returns a value indicating what kind of data is returned.
DESCRIPTION
The XmbLookupString, XwcLookupString and Xutf8LookupString functions
return the string from the input method specified in the buffer_return
argument. If no string is returned, the buffer_return argument is
unchanged.
The KeySym into which the KeyCode from the event was mapped is returned
in the keysym_return argument if it is non-NULL and the status_return
argument indicates that a KeySym was returned. If both a string and a
KeySym are returned, the KeySym value does not necessarily correspond
to the string returned.
XmbLookupString and Xutf8LookupString return the length of the string
in bytes, and XwcLookupString returns the length of the string in
characters. Both XmbLookupString and XwcLookupString return text in
the encoding of the locale bound to the input method of the specified
input context, and Xutf8LookupString returns text in UTF-8 encoding.
Each string returned by XmbLookupString and XwcLookupString begins in
the initial state of the encoding of the locale (if the encoding of the
locale is state-dependent).
Note: To ensure proper input processing, it is essential that the
client pass only KeyPress events to XmbLookupString, XwcLookupString
and Xutf8LookupString. Their behavior when a client passes a
KeyRelease event is undefined.
Clients should check the status_return argument before using the other
returned values. These three functions each return a value to
status_return that indicates what has been returned in the other
arguments. The possible values returned are:
XBufferOverflow The input string to be returned is too
large for the supplied buffer_return. The
required size (for XmbLookupString,
Xutf8LookupString in bytes; for
XwcLookupString in characters) is returned
as the value of the function, and the
contents of buffer_return and keysym_return
are not modified. The client should recall
the function with the same event and a
buffer of adequate size to obtain the
string.
XLookupNone No consistent input has been composed so
far. The contents of buffer_return and
keysym_return are not modified, and the
function returns zero.
XLookupChars Some input characters have been composed.
They are placed in the buffer_return
argument, using the encoding described
above, and the string length is returned as
the value of the function. The content of
the keysym_return argument is not modified.
XLookupKeySym A KeySym has been returned instead of a
string and is returned in keysym_return.
The content of the buffer_return argument
is not modified, and the function returns
zero.
XLookupBoth Both a KeySym and a string are returned;
XLookupChars and XLookupKeySym occur
simultaneously.
It does not make any difference if the input context passed as an
argument to XmbLookupString, XwcLookupString and Xutf8LookupString is
the one currently in possession of the focus or not. Input may have
been composed within an input context before it lost the focus, and
that input may be returned on subsequent calls to XmbLookupString,
XwcLookupString or Xutf8LookupString even though it does not have any
more keyboard focus.
The function Xutf8LookupString is an extension introduced by The
XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated
by the macro X_HAVE_UTF8_STRING.
SEE ALSO
XLookupKeysym(3), Compose(5) Xlib - C Language X Interface
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
