xenocara/lib/libXt/man/XtSetLanguageProc.man

119 lines
3.9 KiB
Groff
Raw Normal View History

2006-11-25 11:01:46 -07:00
.\" Copyright 1993 X Consortium
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be
.\" included in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.\" Except as contained in this notice, the name of the X Consortium shall
.\" not be used in advertising or otherwise to promote the sale, use or
.\" other dealings in this Software without prior written authorization
.\" from the X Consortium.
.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
.ds xW X Toolkit Athena Widgets \- C Language Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.ds Rn 3
.ds Vn 2.2
2020-01-14 13:48:59 -07:00
.ie \n(.g .ds `` \(lq
.el .ds `` ``
.ie \n(.g .ds '' \(rq
.el .ds '' ''
2006-11-25 11:01:46 -07:00
.hw XtSet-Language-Proc wid-get
.na
.TH XtSetLanguageProc __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtSetLanguageProc \- set the language procedure
.SH SYNTAX
2020-01-14 13:48:59 -07:00
#include <X11/Intrinsic.h>
2006-11-25 11:01:46 -07:00
.HP
2020-01-14 13:48:59 -07:00
XtLanguageProc XtSetLanguageProc(XtAppContext \fIapp_context\fP, XtLanguageProc
2012-03-10 09:45:48 -07:00
\fIproc\fP, XtPointer \fIclient_data\fP);
2006-11-25 11:01:46 -07:00
.SH ARGUMENTS
.IP \fIapp_context\fP 1i
Specifies the application context in which the language procedure
is to be used, or NULL.
.LP
.IP \fIproc\fP 1i
Specifies the language procedure, or NULL.
.LP
.IP \fIclient_data\fP 1i
Specifies additional client data to be passed to the language procedure
when it is called.
.SH DESCRIPTION
2020-01-14 13:48:59 -07:00
.B XtSetLanguageProc
2006-11-25 11:01:46 -07:00
sets the language procedure that will be called from
2020-01-14 13:48:59 -07:00
.B XtDisplayInitialize
2006-11-25 11:01:46 -07:00
for all subsequent Displays initialized in the specified application
2020-01-14 13:48:59 -07:00
context.
If \fIapp_context\fP is NULL, the specified language procedure
2006-11-25 11:01:46 -07:00
is registered in all application contexts created by the calling process,
2020-01-14 13:48:59 -07:00
including any future application contexts that may be created.
If
2006-11-25 11:01:46 -07:00
\fIproc\fP is NULL a default language procedure is registered.
2020-01-14 13:48:59 -07:00
.B XtSetLanguageProc
returns the previously registered language procedure.
If a language
2006-11-25 11:01:46 -07:00
procedure has not yet been registered, the return value is unspecified
but if this return value is used in a subsequent call to
2020-01-14 13:48:59 -07:00
.BR XtSetLanguageProc ,
2006-11-25 11:01:46 -07:00
it will cause the default language procedure to be registered.
.LP
The default language procedure does the following:
.IP \(bu 5
2020-01-14 13:48:59 -07:00
Sets the locale according to the environment.
On ANSI C-based systems
2006-11-25 11:01:46 -07:00
this is done by calling
2020-01-14 13:48:59 -07:00
.BR setlocale (
.BR LC_ALL ,
language ).
If an error is encountered a warning message is issued with
.BR XtWarning .
2006-11-25 11:01:46 -07:00
.IP \(bu 5
Calls
2020-01-14 13:48:59 -07:00
.B XSupportsLocale
to verify that the current locale is supported.
If the locale is not
2006-11-25 11:01:46 -07:00
supported, a warning message is issued with
2020-01-14 13:48:59 -07:00
.B XtWarning
and the locale is set to \*(``C\*(''.
2006-11-25 11:01:46 -07:00
.IP \(bu 5
Calls
2020-01-14 13:48:59 -07:00
.B XSetLocaleModifiers
2006-11-25 11:01:46 -07:00
specifying the empty string.
.IP \(bu 5
2020-01-14 13:48:59 -07:00
Returns the value of the current locale.
On ANSI C-based systems this
2006-11-25 11:01:46 -07:00
is the return value from a final call to
2020-01-14 13:48:59 -07:00
.BR setlocale (
.BR LC_ALL ,
2006-11-25 11:01:46 -07:00
NULL ).
.LP
A client wishing to use this mechanism to establish locale can do so
by calling
2020-01-14 13:48:59 -07:00
.B XtSetLanguageProc
2012-03-10 09:45:48 -07:00
prior to
2020-01-14 13:48:59 -07:00
.B XtDisplayInitialize.
2006-11-25 11:01:46 -07:00
.SH "SEE ALSO"
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP